coiled/Coiled Run
GitHub Action to run CLI jobs on VM via Coiled
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| command | Command to run on VM. | yes | — |
| name | Run name. This identifier controls whether `coiled run` invocations are dispatched to the same cloud VM or not. Use the same name to run multiple commands on the same VM. Defaults to a unique name with no VM reuse. | no | — |
| workspace | Coiled workspace (uses default workspace if not specified). | no | — |
| software | Software environment name to use. If neither software nor container is specified, all the currently-installed Python packages are replicated on the VM using package sync. | no | — |
| container | Container image to use. If neither software nor container is specified, all the currently-installed Python packages are replicated on the VM using package sync. | no | — |
| vm-type | VM type to use. Specify multiple types separated by spaces to provide multiple options. | no | — |
| gpu | Have a GPU available. | no | — |
| region | The cloud provider region in which to run the notebook. | no | — |
| disk-size | Use larger-than-default disk on VM, specified in GiB. | no | — |
| keepalive | Keep your VM running for the specified time, even after your command completes. In seconds (``60``) unless you specify units (``3m`` for 3 minutes). Default to shutdown immediately after the command finishes. | no | — |
| file | Local files required to run command. Can be either individual file or entire directory. Multiple values can be specified, by separating with spaces (``foo.txt my-subdir/``). | no | — |
| env | Environment variables securely transmitted to run command environment. Format is ``KEY=val``, multiple vars can be specified by separating with spaces. | no | — |
| subdomain | Custom subdomain for the VM hostname. | no | — |
| allow-ssh-from | IP address or CIDR from which connections to port 22 (SSH) are open; can also be specified as 'everyone' (0.0.0.0/0) or 'me' (automatically determines public IP detected for your local client). Note that ``coiled run`` relies on SSH connection for executing commands on VM. [default: me] | no | — |
| port | Open extra ports in network firewall for inbound connections (multiple ports can be set by separating them with spaces). | no | — |
| interactive | Open an interactive session, e.g., ``coiled run --interactive bash`` or ``coiled run --interactive python``. | no | — |
| detach | Start the run in the background, don't wait for the results. | no | — |
| sync | Sync files between local working directory and ``/scratch/synced``. | no | — |
| root | Act as root in Docker container. | no | — |
| forward-gcp-adc | Forward long-lived Google Cloud Application Default Credentials to VM for data access. | no | — |
| tag | Tags. Format is ``KEY=val``, multiple vars can be set by separating with spaces. | no | — |
| sync-ignore | Paths to not sync when using ``sync``. | no | — |
| mount-bucket | S3 or GCS bucket(s) to mount as volumes. | no | — |
Outputs
no outputs