Difference between revisions of "Shell (API)"

From ComputerCraft Wiki
Jump to: navigation, search
m (Made it clear that arg for shell.programs() is optional)
(added NeedsWork tag)
Line 1: Line 1:
 +
{{NeedsWork|Need to add pages for the shell functions--[[User:Cranium|Cranium]] 17:10, 10 May 2013 (MSK)}}
 +
 
The shell API allows you to interface with the [http://en.wikipedia.org/wiki/Shell_%28computing%29 shell].
 
The shell API allows you to interface with the [http://en.wikipedia.org/wiki/Shell_%28computing%29 shell].
  

Revision as of 13:10, 10 May 2013

This page needs some serious TLC, stat!
Please help us by cleaning it, fixing it up, or sparing it some love.
(Reason: Need to add pages for the shell functions--Cranium 17:10, 10 May 2013 (MSK))

The shell API allows you to interface with the shell.

Grid disk.png   Shell (API)

Method NameDescription
shell.exit() Exits the current shell
shell.dir() Returns the directory
shell.setDir(string path) Sets the directory
shell.path() Returns the path
shell.setPath(string path) Sets the path
shell.resolve(string localpath) Resolves a local path to an absolute path.
shell.resolveProgram(string name) Resolves the absolute path to the program whose name you provided.
shell.aliases() Returns aliases.
shell.setAlias(string alias, string program) Sets an alias.
shell.clearAlias(string alias, string program) Clears an alias.
shell.programs([boolean hidden]) Returns a table of programs.
shell.run(string program, string arguments) Runs a program.
shell.getRunningProgram() Returns the absolute path to the currently-executing program.