Shell (API)

From ComputerCraft Wiki
Revision as of 19:44, 4 April 2014 by MKlegoman357 (Talk | contribs) (Rewrote some descriptions of some functions)

Jump to: navigation, search

The shell API allows you to interface with the shell.


Returns Method name Description
shell.exit() Exits the current shell.
string directory shell.dir() Returns the path to the working directory.
shell.setDir(string path) Sets the working directory.
string path shell.path() Returns the path.
shell.setPath(string path) Sets the path.
string path shell.resolve(string localpath) Resolves a local path to an absolute path.
string path shell.resolveProgram(string name) Resolves the absolute path to the program whose name you provided.
table aliases shell.aliases() Returns aliases.
shell.setAlias(string alias, string program) Sets an alias.
shell.clearAlias(string alias) Clears an alias.
table programs shell.programs([boolean showHidden]) Returns a table of files in the current directory and in rom/programs.
boolean success command [, string args1, string args2, ...]) Runs a program.
string path shell.getRunningProgram() Returns the absolute path to the currently-executing program.
number newTabID shell.openTab(string command [, string args1, string args2, ...]) Runs a program in another multishell tab. Requires version 1.6 or newer and an advanced system.
shell.switchTab(number tabID) Switches the multishell tab to tab with the given ID. Requires version 1.6 or newer and an advanced system.

Note that and shell.openTab concatenate any arguments they are given (with single space separator characters) before parsing the command, and as of ComputerCraft version 1.45, now also support a single string containing all parameters.