Sliplane CLI

A blazing fast, native command-line tool and agent interface for the Sliplane cloud hosting platform API (v0, OpenAPI spec 0.5.0). Built in Rust for developers and autonomous AI workflows.

---

Highlights

• ⚡ Sub-3ms Startup: Compiled as a native static binary with zero runtime dependencies. Executes in ~1–3 ms (compared to ~75 ms for managed runtimes).
• 🔐 OS Keystore Integration: sliplane login prompts for your token securely and saves it to native OS vaults (macOS Keychain, Linux Secret Service / Keyutils, Windows DPAPI).
• 🌐 Full 65-Endpoint API Coverage: Complete command surface across compute servers, web services, managed PostgreSQL databases, S3 object storage buckets, and OAuth clients.
• 🤖 AI Agent Native: Machine-readable --json output, standardized error envelopes with stable exit codes, and explicit llms.txt agent guidance.
• 🛡️ Safety Guardrails: Strict account scoping protects multi-tenant setups; safeguards prevent accidental deletion of environment variables or secrets.

---

Installation

Using Cargo

cargo install --git https://github.com/SpaceCorps/Sliplane-Cli --locked

Pre-built Standalone Binaries

Download standalone binary archives directly from the GitHub Releases page:

Platform	Architecture	Binary Package
macOS	Apple Silicon (aarch64)	sliplane-v1.0.0-aarch64-apple-darwin.tar.gz
macOS	Intel (x86_64)	sliplane-v1.0.0-x86_64-apple-darwin.tar.gz
Linux	x86_64 (musl static)	sliplane-v1.0.0-x86_64-unknown-linux-musl.tar.gz
Windows	x64 (MSVC)	sliplane-v1.0.0-x86_64-pc-windows-msvc.zip

---

Quickstart

1. Authenticate

Run sliplane login to launch your browser, copy your API token, verify it against GET /v0/me, and store it in your OS keystore:

# Interactive browser login (saved under account 'default')
sliplane login

# Log in with a specific account name
sliplane login staging

# Headless / CI pipeline login (reads token from stdin with no shell history trace)
echo "$SLIPLANE_API_KEY" | sliplane login ci --api-key-stdin

2. Verify Identity & List Resources

# Verify your token identity
sliplane me -a default

# List all projects
sliplane projects list -a default

# View compute servers
sliplane servers list -a default

3. Deploy & Manage Services

# Deploy a web service
sliplane services deploy --project-id prj_123 --service-id srv_abc -a default

# Stream live container logs
sliplane services logs --project-id prj_123 --service-id srv_abc -a default

---

Command Reference

Every command that accesses the API accepts --account <name> (short -a <name>).

Identity & Authentication

Command	Description
sliplane login [name]	Interactively authenticate with your API token and save it to the OS keystore
sliplane me	Query identity, email, and organization context for the active token
sliplane accounts list [--check]	List configured accounts (pass --check to verify token validity)
sliplane accounts test <name>	Test credentials for a specific account
sliplane accounts add <name>	Manually add an account and API key to the keystore
sliplane accounts remove <name>	Remove an account and purge its key from the local keystore

Projects & Servers

Command	Description
sliplane projects list	List all projects
sliplane projects create --name <name>	Create a new project
sliplane projects update --project-id <id> --name <name>	Rename a project
sliplane projects delete --project-id <id>	Delete an empty project
sliplane servers list	List all servers with instance sizes and locations
sliplane servers get --server-id <id>	Inspect server details and resource allocations
sliplane servers create --name <n> --instance-type <t> --location <loc>	Provision a new compute server
sliplane servers rescale --server-id <id> --instance-type <t>	Scale server instance size up
sliplane servers rescale-disk --server-id <id> --disk-size <gb>	Expand server storage volume disk size
sliplane servers metrics --server-id <id>	Query CPU and memory utilization metrics
sliplane servers volumes --server-id <id>	List attached persistent storage volumes

Services & Deployments

Command	Description
sliplane services list --project-id <id>	List services within a project
sliplane services get --project-id <p> --service-id <s>	Fetch detailed service configuration
sliplane services create --project-id <p> (--image <img> | --repo <r>)	Deploy a new container service
sliplane services update --project-id <p> --service-id <s>	Update service deployment settings (see safeguards below)
sliplane services deploy --project-id <p> --service-id <s>	Trigger immediate redeployment
sliplane services logs --project-id <p> --service-id <s> [--to <ts>]	Read container logs (paginated, 500 lines per call)
sliplane services pause / unpause	Pause or resume container execution
sliplane services set-env --project-id <p> --service-id <s> --key <k> --value <v>	Safely set or update a single environment variable
sliplane services delete-env --project-id <p> --service-id <s> --key <k>	Remove a single environment variable
sliplane services add-domain / remove-domain	Configure custom domain routing

Managed PostgreSQL & Storage

Command	Description
sliplane postgres list	List all managed PostgreSQL instances
sliplane postgres get --postgres-id <id>	Retrieve database connection endpoints and credentials
sliplane postgres create --name <n> --instance-type <t> --region <r>	Provision a managed PostgreSQL instance
sliplane postgres update --postgres-id <id> --ip-allow <cidr>=<label>	Update instance configuration or IP allowlist
sliplane postgres rotate-credentials --postgres-id <id>	Rotate database access password
sliplane postgres slow-queries / top-queries	Inspect query performance and call frequency
sliplane buckets list	List S3-compatible object storage buckets
sliplane buckets create --name <n> --region <r>	Create an S3 object storage bucket
sliplane buckets keys --bucket-id <id>	List S3 access keys
sliplane buckets create-key --bucket-id <id> --name <label>	Generate scoped S3 access key and secret

---

Output Formats & AI Agent Readiness

Commands format stdout as clean YAML by default. Pass --json when parsing outputs with jq, Python, or LLM tool-calling loops:

# Parse status with jq
sliplane services get --project-id prj_123 --service-id srv_abc -a default --json | jq -r .status

Machine-Readable Error Envelopes

Errors are output to stderr as structured envelopes with stable exit codes:

{
  "code": "auth_required",
  "message": "Token expired or missing.",
  "remediation": "Run 'sliplane login default' to authenticate."
}

Exit Code	Error Symbol	Handling Directive
0	ok	Command succeeded
1	error	General failure; unclassified
2	network	Network connectivity failure; retry once
3	auth_required	Unauthenticated; surface remediation to user
4	not_found	Resource does not exist; do not retry
5	rate_limited	API rate limit reached; back off before retrying
6	invalid_input	Parameter schema validation failed
7	no_account	Requested account not configured in keystore

Agent Manuals

Inspect built-in agent guides directly from the CLI:

sliplane agent-readme          # Human-readable markdown guide
sliplane agent-readme --json   # Machine-readable rules and schemas

For web-based LLMs and crawlers, refer to llms.txt and llms-full.txt.

---

Important Operational Behaviors

1. Environment Variables (--env vs --merge-env):
   • Passing --env to services update replaces the entire environment array. The CLI warns and aborts if unmentioned variables would be dropped.
   • Use --merge-env to preserve unmentioned variables, or --replace-env if removal was intentional.
   • Use services set-env to change a single variable safely.
2. Preserving Secrets:
   • In Sliplane, secret values are write-only and read back as empty strings. --merge-env safely retains existing secrets without exposing or overwriting them.
3. Carrying Over Deployments:
   • services update automatically carries over existing deployment parameters (branch, Dockerfile path, build context, path filters) so they do not inadvertently revert to defaults.
4. Volume Resolution:
   • --volume my-data:/data automatically binds to an existing server volume named my-data rather than creating duplicates.
5. Windows Shells:
   • Run from PowerShell or cmd.exe. Avoid Git Bash / MSYS, which automatically rewrites Unix-style path arguments (/health → C:/Program Files/Git/...).

---

Configuration & Environment Variables

Variable	Description	Default
SLIPLANE_CONFIG_DIR	Custom directory path for config.yaml	~/.config/sliplane (or OS equivalent)
SLIPLANE_SECRET_STORE	Force specific credential store: dpapi, keychain, libsecret, plaintext	Auto-detected
SLIPLANE_ALLOW_PLAINTEXT_STORE	Set to 1 to allow a chmod 0600 file store on headless Linux without DBus/SecretService	0
SLIPLANE_API_URL	Override the API base URL (useful for integration testing against mocks)	https://ctrl.sliplane.io/v0

---

Contributing & License

Contributions are welcome! Please submit issues and pull requests to SpaceCorps/Sliplane-Cli.

Dual-licensed under the MIT License.