\n \n | Pitcrew can run commands | \n \n $ crew sh date\n | \n
\n \n | ...or over ssh | \n \n $ crew sh -p providers.ssh -P '{\"hosts\": [\"192.168.0.1\"]}' date\n | \n
\n \n | on hundreds of hosts! | \n \n $ crew sh -p providers.ssh -P '{\"hosts\": [\"192.168.0.1-100\"]}' date\n | \n
\n \n | Crew can also run tasks | \n \n $ crew run install.homebrew\n | \n
\n \n | Tasks are either other shell commands, or other tasks, for example,\n this provisions Cloudfront, SSL and S3 and builds and deploys docs to pitcrew.io | \n \n $ crew run examples.deploy_pitcrew\n | \n
\n \n | You can list available tasks | \n \n $ crew list\n | \n
\n \n | ...edit an existing task | \n \n $ crew edit examples.deploy_pitcrew\n # opens in $EDITOR\n | \n
\n \n | or create a new task! | \n \n $ crew new some.new.task\n | \n
\n
\n\n## Installation\n\n### From binary\n\nTo install pitcrew in your home directory, run the following:\n\n```\ncurl -fsSL \"https://github.com/joshbuddy/pitcrew/releases/latest/download/crew-$(uname)\" > crew\nchmod u+x crew\n./crew run crew.install --dest=\"$HOME/crew\"\n```\n\n### From PyPi\n\nTo install from the Python Package Index, run the following:\n\n```\npip install pitcrew\ncrew run crew.install --dest=\"$HOME/crew\"\n```\n\n### From source\n\n```\ngit clone https://github.com/joshbuddy/pitcrew\ncd pitcrew\npython3.6 -m venv env\nsource env/bin/activate\npip install -e .\n```\n\n## Concepts\n\nA command or set of commands is called a **task**. A **context** runs tasks either locally, on docker or over ssh.\nA **provider** generates contexts.\n\n### Tasks\n\nTasks are either composed from other tasks or invoking a command on a shell.\n\nAn example of a *task* might be reading a file. `fs.read(path)` reads a file as bytes and returns it:\n\n### `pitcrew/tasks/fs/read.py`\n\n```python\nimport base64\nfrom pitcrew import task\n\n\n@task.arg(\"path\", desc=\"The file to read\", type=str)\n@task.returns(\"The bytes of the file\")\nclass FsRead(task.BaseTask):\n \"\"\"Read value of path into bytes\"\"\"\n\n async def run(self) -> bytes:\n code, out, err = await self.sh_with_code(f\"cat {self.params.esc_path}\")\n assert code == 0, \"exitcode was not zero\"\n return out\n\n```\n\nOther tasks might include writing a file, installing xcode or cloning a git repository. All the currently available\ntasks are listed at [docs/tasks.md](docs/tasks.md). The api available in a task is available at [docs/api.md#crewtask](docs/api.md#crewtask).\n\n### Contexts\n\nAn example of a *context* might be over ssh, or even locally. Learn more about contexts at [docs/api.md#crewcontext](docs/api.md#crewcontext).\n\n### Providers\n\nA *provider* is a task with a specific return type. The return type is an async iterator which returns contexts.\n\n## Usage\n\nFor detailed usage, see [docs/cli.md](docs/cli.md) for more details.\n\n### Run a command\n\nPitcrew allows running a command using `bin/crew sh -- [shell command]`.\n\nFor example `crew sh ls /` will list the \"/\" directory locally.\n\nYou can run this across three hosts via ssh using `crew sh -p providers.ssh -P '{\"hosts\": [\"192.168.0.1\", \"192.168.0.2\", \"192.168.0.3\"]}' ls /`.\n\n### Run a task\n\nPitcrew allows running a task using `crew run [task name]