All commands
Every command in one table you can filter.
36 commands
task:createRegister a task name and write the starter files for it.- needs API key · offline with --local
- --json: full
task:listList your tasks, one page at a time.- needs API key
- --json: full
task:getReport a task's deploys, runs, and what the next deploy and run will do.- API key optional
- --json: full
task:validateCheck task.yaml on your machine, without sending or building anything.- offline · key needed with --review-packages
- --json: full
task:packList the files that task:deploy would upload, without building or sending.- offline
- --json: full
task:deployUpload your task source and wait until the platform has built it.- needs API key · offline with --check
- waits
- --json: full
task:runStart one run of a task from its latest deployment.- needs API key
- waits
- --json: full
task:deleteDelete a task with all its deployments and runs.- needs API key
- asks to confirm
- deletes data
- --json: full
deployment:listList your live deployments with the size of each image.- needs API key
- --json: full
deployment:getShow one deployment: status, size, integrity and build details.- needs API key
- --json: full
deployment:deleteDelete a deployment together with its runs.- needs API key
- asks to confirm
- deletes data
- --json: full
run:listList your runs, with filters.- needs API key
- --json: full
run:getShow one run: status, timing and the result of the task.- needs API key
- --json: full
run:logsPrint the console output of a run, exactly as the task wrote it.- needs API key
- --json: none
run:cancelStop a live run, gracefully by default.- needs API key
- asks to confirm
- --json: full
run:deleteDelete the record of a run, without stopping its VM.- needs API key
- asks to confirm
- deletes data
- --json: full
vm:listList your live VMs with their state, age and idle time.- needs API key
- --json: full
vm:getShow one VM: residency, state, age and its task nature.- needs API key
- --json: full
vm:deleteTear down a VM by hand.- needs API key
- asks to confirm
- deletes data
- --json: full
secret:setStore a secret value under a name, read from stdin.- needs API key
- --json: full
secret:listList the names of your secrets and when each was updated.- needs API key
- --json: full
secret:deleteDelete a secret.- needs API key
- asks to confirm
- deletes data
- --json: full
schedule:listList runs that wait for a time, soonest first.- needs API key
- --json: full
schedule:cancelCancel one scheduled run so that it never fires.- needs API key
- asks to confirm
- deletes data
- --json: full
hook:createCreate a webhook that starts a run of one task.- needs API key
- --json: full
hook:listList the webhooks of a deployment, oldest first.- needs API key
- --json: full
hook:deleteDelete a webhook.- needs API key
- asks to confirm
- deletes data
- --json: full
notify:setSet or clear the callback URL of a deployment.- needs API key
- --json: full
loginSign this machine in and save its API key.- offline
- --json: none
logoutRevoke this machine's key and delete the saved file.- offline
- deletes data
- --json: none
whoamiShow who your API key belongs to, your limits and what you use.- needs API key
- --json: full
quotaShow what you hold now against your limits.- needs API key
- --json: full
usageShow what you used in one month, by axis.- needs API key
- --json: full
usage:exportExport the usage lines of a month as JSON or CSV.- needs API key
- --json: full
--versionPrint the client version, and the API version if the server answers.- offline
- --json: none
helpPrint the usage of every command, or of one command.- offline
- --json: none
No command matches. Clear the filter to see all.