{"_id":"54fda39021538c21006c49b7","category":{"_id":"54fda38f21538c21006c49a7","project":"545e249c7ca5470800b3a1b2","version":"54fda38e21538c21006c49a6","__v":3,"pages":["54fda39021538c21006c49b6","54fda39021538c21006c49b7","54fda39021538c21006c49b8","54fda39021538c21006c49b9","54fda39021538c21006c49ba","54fda39021538c21006c49bb","54fda5d10c05ea25004ce0cd","5582f41f81672a3900bb4fe9"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-11-08T14:11:40.826Z","from_sync":false,"order":0,"slug":"documentation","title":"Documentation"},"version":{"_id":"54fda38e21538c21006c49a6","__v":3,"forked_from":"54eb4535615ffc19003059f0","project":"545e249c7ca5470800b3a1b2","createdAt":"2015-03-09T13:43:42.927Z","releaseDate":"2015-03-09T13:43:42.927Z","categories":["54fda38f21538c21006c49a7","54fda38f21538c21006c49a8","54fda38f21538c21006c49a9","54fda38f21538c21006c49aa","54fda38f21538c21006c49ab","54fda3d347f93619001d2ae2","54fea8975c4ab10d00ef4279"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.5.0","version":"0.5.0"},"user":"545e246f7ca5470800b3a1b1","githubsync":"","project":"545e249c7ca5470800b3a1b2","__v":5,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-11-09T16:35:44.231Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"auth":"never","params":[],"url":""},"isReference":false,"order":3,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Common options\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Option\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`-c`, `--config`\",\n    \"0-1\": \"Path to the configuration file.\",\n    \"0-2\": \"Defaults to: `./Sheepfile`\",\n    \"1-0\": \"`-v`, `--verbose`\",\n    \"1-1\": \"Set the log level to debug.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"decrypt INPUT OUTPUT\"\n}\n[/block]\nDecrypt an encrypted backup file using the provided GPG private key. See our [Introduction](doc:introduction) to encryption and [Encrypt your backup files](doc:encrypt-your-backup-files) for more.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Option\",\n    \"0-0\": \"`-k`, `--key`\",\n    \"0-1\": \"The **private key** to use.\",\n    \"0-2\": \"Required: yes\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"encrypt SECRET\"\n}\n[/block]\nEncrypt the provided secret using the provided GPG public key. See our [Introduction](doc:introduction) to encryption and [Encrypt your credentials](doc:encrypt-your-credentials) for more.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Option\",\n    \"0-0\": \"`-k`, `--key`\",\n    \"0-1\": \"The **public key** (at runtime, ESIO decrypts the secret will use the job's private key).\",\n    \"0-2\": \"Required: yes\",\n    \"h-1\": \"Description\",\n    \"1-0\": \"`-a`, `--standard-armor`\",\n    \"1-1\": \"Do not strip PGP headers and carriage returns.\",\n    \"1-2\": \"Defaults to: `false`\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"help [COMMAND]\"\n}\n[/block]\nShow general help message or help for a specific command.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"restart\"\n}\n[/block]\nStop the master process, if any, then start a new one and place it in the background. See the start command for a list of available options.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"start\"\n}\n[/block]\nStart a master process and activate [scheduling of the backup jobs](doc:schedule-your-backups). Whenever a schedule expires the master forks a worker to process the corresponding backup job.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Option\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`-f`, `--pidfile`\",\n    \"0-1\": \"The path to the PID file of the master process\",\n    \"0-2\": \"Defaults to: `./electric_sheep.pid`\",\n    \"1-0\": \"`-l`, `--logfile`\",\n    \"1-1\": \"The path to the log file\",\n    \"1-2\": \"Defaults to: `./electric_sheep.log`\",\n    \"2-0\": \"`-w`, `--workers`\",\n    \"2-1\": \"The maximum number of workers to launch in parallel\",\n    \"2-2\": \"Defaults to: `1`\",\n    \"3-0\": \"`-d`, `--daemon`\",\n    \"3-1\": \"Place the process in the background and return control to the terminal\",\n    \"3-2\": \"Defaults to: `false`\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\nThe master process usually consumes less than 100 MB RAM, where workers may temporarily eat up to 500 MB when processing large files. You may increase the allowed number of parallel workers according to the resources available on the machine in which ESIO is run.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"stop\"\n}\n[/block]\nGet the PID of an existing master process from the `pidfile` and sends it the `TERM` signal so that it stops gracefully.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Option\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`-f`, `--pidfile`\",\n    \"0-1\": \"The path to the PID file of the master process\",\n    \"0-2\": \"Defaults to: `./electric_sheep.pid`\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"version\"\n}\n[/block]\nShow the version number and the SHA-1 hash of the Git revision.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"work\"\n}\n[/block]\nRun projects in the `Sheepfile` in sequence.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Option\",\n    \"h-1\": \"Description\",\n    \"0-2\": \"Defaults to: all jobs.\",\n    \"0-1\": \"Name of a single job to execute\",\n    \"0-0\": \"`-j`, `--job`\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]","excerpt":"CLI commands and options","slug":"command-line","type":"basic","title":"Command Line Reference"}

Command Line Reference

CLI commands and options

[block:api-header] { "type": "basic", "title": "Common options" } [/block] [block:parameters] { "data": { "h-0": "Option", "h-1": "Description", "0-0": "`-c`, `--config`", "0-1": "Path to the configuration file.", "0-2": "Defaults to: `./Sheepfile`", "1-0": "`-v`, `--verbose`", "1-1": "Set the log level to debug." }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "decrypt INPUT OUTPUT" } [/block] Decrypt an encrypted backup file using the provided GPG private key. See our [Introduction](doc:introduction) to encryption and [Encrypt your backup files](doc:encrypt-your-backup-files) for more. [block:parameters] { "data": { "h-0": "Option", "0-0": "`-k`, `--key`", "0-1": "The **private key** to use.", "0-2": "Required: yes" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "encrypt SECRET" } [/block] Encrypt the provided secret using the provided GPG public key. See our [Introduction](doc:introduction) to encryption and [Encrypt your credentials](doc:encrypt-your-credentials) for more. [block:parameters] { "data": { "h-0": "Option", "0-0": "`-k`, `--key`", "0-1": "The **public key** (at runtime, ESIO decrypts the secret will use the job's private key).", "0-2": "Required: yes", "h-1": "Description", "1-0": "`-a`, `--standard-armor`", "1-1": "Do not strip PGP headers and carriage returns.", "1-2": "Defaults to: `false`" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "help [COMMAND]" } [/block] Show general help message or help for a specific command. [block:api-header] { "type": "basic", "title": "restart" } [/block] Stop the master process, if any, then start a new one and place it in the background. See the start command for a list of available options. [block:api-header] { "type": "basic", "title": "start" } [/block] Start a master process and activate [scheduling of the backup jobs](doc:schedule-your-backups). Whenever a schedule expires the master forks a worker to process the corresponding backup job. [block:parameters] { "data": { "h-0": "Option", "h-1": "Description", "0-0": "`-f`, `--pidfile`", "0-1": "The path to the PID file of the master process", "0-2": "Defaults to: `./electric_sheep.pid`", "1-0": "`-l`, `--logfile`", "1-1": "The path to the log file", "1-2": "Defaults to: `./electric_sheep.log`", "2-0": "`-w`, `--workers`", "2-1": "The maximum number of workers to launch in parallel", "2-2": "Defaults to: `1`", "3-0": "`-d`, `--daemon`", "3-1": "Place the process in the background and return control to the terminal", "3-2": "Defaults to: `false`" }, "cols": 3, "rows": 4 } [/block] The master process usually consumes less than 100 MB RAM, where workers may temporarily eat up to 500 MB when processing large files. You may increase the allowed number of parallel workers according to the resources available on the machine in which ESIO is run. [block:api-header] { "type": "basic", "title": "stop" } [/block] Get the PID of an existing master process from the `pidfile` and sends it the `TERM` signal so that it stops gracefully. [block:parameters] { "data": { "h-0": "Option", "h-1": "Description", "0-0": "`-f`, `--pidfile`", "0-1": "The path to the PID file of the master process", "0-2": "Defaults to: `./electric_sheep.pid`" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "version" } [/block] Show the version number and the SHA-1 hash of the Git revision. [block:api-header] { "type": "basic", "title": "work" } [/block] Run projects in the `Sheepfile` in sequence. [block:parameters] { "data": { "h-0": "Option", "h-1": "Description", "0-2": "Defaults to: all jobs.", "0-1": "Name of a single job to execute", "0-0": "`-j`, `--job`" }, "cols": 3, "rows": 1 } [/block]