Run CLI reference
Source: @socra/run-cli@0.4.1.
This reference includes every command, argument, and option declared by this released package. Defaults and accepted values are included where the package declares them. Command-specific validation and permissions also apply; see the API reference for resource contracts.
Use socra run --help, or append --help to any command, to inspect the locally installed version.
socra run
Build and run code on Socra
Scroll to see all columns.
| Command | Purpose |
|---|---|
socra run deploy | Build and deploy a workload |
socra run rollback | Redeploy an immutable revision |
socra run logs | Print or follow deployment logs |
socra run events | Show deployment lifecycle events |
socra run status | Show deployment health and URL |
socra run workload | Stable runnable services and jobs |
socra run deployment | Deployment executions |
socra run revision | Immutable successful runtime revisions |
socra run route | Custom hostnames routed to service workloads |
socra run deploy
Build and deploy a workload
Text
socra run deploy <workload> [options]
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
workload | Yes | Workload name |
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--project | Value | Socra project id or slug (or SOCRA_PROJECT) |
--image | Value | OCI image pinned by sha256 digest |
socra run rollback
Redeploy an immutable revision
Text
socra run rollback <revision>
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
revision | Yes | Revision id |
socra run logs
Print or follow deployment logs
Text
socra run logs <deployment> [options]
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
deployment | Yes | Deployment id |
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--follow | Presence flag | Stream until deployment completes |
socra run events
Show deployment lifecycle events
Text
socra run events <deployment>
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
deployment | Yes | Deployment id |
socra run status
Show deployment health and URL
Text
socra run status <deployment>
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
deployment | Yes | Deployment id |
socra run workload
Stable runnable services and jobs
Scroll to see all columns.
| Command | Purpose |
|---|---|
socra run workload create | Create a workload |
socra run workload get | Show a workload |
socra run workload list | List workloads |
socra run workload update | Update workload runtime settings |
socra run workload delete | Delete an unused workload |
socra run workload create
Create a workload
Text
socra run workload create <name> [options]
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
name | Yes | Workload name |
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--project | Value | Socra project id or slug (or SOCRA_PROJECT) |
--kind | Value | service or job |
--port | Value | Listening port |
socra run workload get
Show a workload
Text
socra run workload get <id>
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
id | Yes | Workload id |
socra run workload list
List workloads
Text
socra run workload list [options]
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--project | Value | Socra project id or slug (or SOCRA_PROJECT) |
--limit | Value | Page size |
--after | Value | Page cursor |
socra run workload update
Update workload runtime settings
Text
socra run workload update <id> [options]
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
id | Yes | Workload id |
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--kind | Value | service or job |
--port | Value | Listening port |
--variables | Value | JSON object of plain variables |
--secrets | Value | JSON object mapping env names to sec_ or sev_ ids |
--release-command | Value | JSON argv array |
socra run workload delete
Delete an unused workload
Text
socra run workload delete <id>
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
id | Yes | Workload id |
socra run deployment
Deployment executions
Scroll to see all columns.
| Command | Purpose |
|---|---|
socra run deployment create | Create and wait for a deployment |
socra run deployment get | Show a deployment |
socra run deployment list | List deployments |
socra run deployment logs | Print or follow deployment logs |
socra run deployment events | Show deployment lifecycle events |
socra run deployment health | Show deployment health and URL |
socra run deployment cancel | Cancel a deployment |
socra run deployment create
Create and wait for a deployment
Text
socra run deployment create <workload> [options]
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
workload | Yes | Workload name |
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--project | Value | Socra project id or slug (or SOCRA_PROJECT) |
--image | Value | OCI image pinned by sha256 digest |
socra run deployment get
Show a deployment
Text
socra run deployment get <id>
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
id | Yes | Deployment id |
socra run deployment list
List deployments
Text
socra run deployment list [options]
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--project | Value | Socra project id or slug (or SOCRA_PROJECT) |
--status | Value | Deployment status |
--limit | Value | Page size |
--after | Value | Page cursor |
socra run deployment logs
Print or follow deployment logs
Text
socra run deployment logs <id> [options]
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
id | Yes | Deployment id |
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--follow | Presence flag | Stream until deployment completes |
socra run deployment events
Show deployment lifecycle events
Text
socra run deployment events <id>
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
id | Yes | Deployment id |
socra run deployment health
Show deployment health and URL
Text
socra run deployment health <id>
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
id | Yes | Deployment id |
socra run deployment cancel
Cancel a deployment
Text
socra run deployment cancel <id>
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
id | Yes | Deployment id |
socra run revision
Immutable successful runtime revisions
Scroll to see all columns.
| Command | Purpose |
|---|---|
socra run revision get | Show a revision |
socra run revision list | List revisions |
socra run revision rollback | Redeploy the exact revision configuration |
socra run revision get
Show a revision
Text
socra run revision get <id>
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
id | Yes | Revision id |
socra run revision list
List revisions
Text
socra run revision list [options]
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--project | Value | Socra project id or slug (or SOCRA_PROJECT) |
--limit | Value | Page size |
--after | Value | Page cursor |
socra run revision rollback
Redeploy the exact revision configuration
Text
socra run revision rollback <id>
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
id | Yes | Revision id |
socra run route
Custom hostnames routed to service workloads
Scroll to see all columns.
| Command | Purpose |
|---|---|
socra run route create | Route a claimed Hostname to a workload |
socra run route get | Show a route |
socra run route list | List routes |
socra run route update | Retarget or enable/disable a route |
socra run route delete | Delete a route |
socra run route create
Route a claimed Hostname to a workload
Text
socra run route create <hostname> [options]
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
hostname | Yes | Fully-qualified hostname |
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--project | Value | Socra project id or slug (or SOCRA_PROJECT) |
--workload | Value | Workload name |
socra run route get
Show a route
Text
socra run route get <id>
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
id | Yes | Route id |
socra run route list
List routes
Text
socra run route list [options]
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--project | Value | Socra project id or slug (or SOCRA_PROJECT) |
--hostname | Value | Hostname filter |
--workload | Value | Workload filter |
--status | Value | active or disabled |
--limit | Value | Page size |
--after | Value | Page cursor |
socra run route update
Retarget or enable/disable a route
Text
socra run route update <id> [options]
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
id | Yes | Route id |
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--workload | Value | Workload name |
--status | Value | active or disabled |
socra run route delete
Delete a route
Text
socra run route delete <id>
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
id | Yes | Route id |
Next step
Return to the Run overview.