Package osh

source code

Osh is documented in the following packages and modules:

osh.api: Non-command portions of the osh API.
osh.builtins: Builtin osh functions and classes.
osh.command: Modules implementing osh commands. Documentation covers both the command-line and application programming interfaces.
osh.file: Represents files.
osh.function: Many osh commands (e.g. f, select) take functions as arguments. osh.function has no public interface, but the documentation of this module describes the use of functions in both the command-line and application programming interfaces.
osh.process: Represents currently running processes (Linux only).
osh.trace: Trace osh internals.

Submodules

osh.api: The osh API (Application Programming Interface) supports the use of osh from Python code.
osh.builtins: This module contains miscellaneous functions builtin to osh.
osh.command: These pages document osh commands for both the command-line and application programming interfaces.
- osh.command.agg: agg [-r] [[-g|-c] GROUPING_FUNCTION] INITIAL_VALUE AGGREGATION_FUNCTION
- osh.command.cat: cat FILENAME
- osh.command.copyfrom: copyfrom [-Crpx] FILES LOCAL_DIR
- osh.command.copyto: copyto [-rpC] FILE ... REMOTE_DIR
- osh.command.expand: expand [POSITION]
- osh.command.f: f FUNCTION
- osh.command.fork: For API usage only, (for CLI use osh @FORK [ ... ] syntax instead.)
- osh.command.gen: gen [-p PAD] [COUNT [START]]
- osh.command.head: head N
- osh.command.help: help [OSH_COMMAND]
- osh.command.imp: import MODULE_NAME ...
- osh.command.install: install [-d INSTALL_DIRECTORY] [-p PACKAGE] DIRECTORY
- osh.command.installosh: installosh [-d INSTALL_DIRECTORY] [OSH_CONFIG_FILE]
- osh.command.ls: ls [-01rfds] [FILENAME_PATTERN ...]
- osh.command.merge
- osh.command.out: out [-t] [-a FILENAME] [-f FILENAME] [-c | FORMAT]
- osh.command.ps: ps [-o]
- osh.command.py: py PYTHON_CODE
- osh.command.red: red -r [BINARY_FUNCTION ...]
- osh.command.remote: For API usage only, (for CLI use osh @CLUSTER [ ... ] syntax instead.)
- osh.command.reverse: reverse
- osh.command.select: select FUNCTION
- osh.command.sh: sh COMMAND
- osh.command.sort: sort [FUNCTION]
- osh.command.sql: sql [DB] QUERY
- osh.command.squish: squish [BINARY_FUNCTION ...]
- osh.command.stdin: For API usage only, (for CLI use cat ... | osh ^ ... syntax instead.)
- osh.command.tail: tail N
- osh.command.testssh: testssh
- osh.command.timer: timer [-t] INTERVAL
- osh.command.unique: unique [-c]
- osh.command.version: version
- osh.command.window: window PREDICATE
osh.file: Represents a file or directory on the local host.
osh.function: Encapsulates functions used in osh commands such as f and select.
osh.process: Provides information on currently running processes, by examining files in the /proc filesystem.
osh.trace