Command Reference

Complete reference for every Ink CLI command — deploy, manage, observe, and configure your services

Services

`ink deploy`

Create and deploy a new service.

ink deploy <name> [flags]

Flag	Default	Description
`--repo`	Service name	Repository name
`--host`	`ink`	Git host: `ink` (managed) or `github`
`--branch`	`main`	Git branch to deploy
`--region`	`us-east-1`	Deploy region
`--memory`	`256Mi`	Memory: 128Mi, 256Mi, 512Mi, 1024Mi, 2048Mi, 4096Mi
`--vcpu`	`0.25`	vCPU: 0.1, 0.2, 0.25, 0.3, 0.4, 0.5, 1, 2, 4
`--port`	Auto-detected	Application port
`--buildpack`	`railpack`	Build strategy: `railpack`, `dockerfile`, `static`
`--build-command`	—	Custom build script
`--start-command`	—	Custom start script
`--root-dir`	—	Monorepo subdirectory
`--publish-dir`	—	Static site output directory (dist, build, out)
`--dockerfile`	—	Path to Dockerfile
`--env`	—	Environment variable `KEY=VALUE` (repeatable)
`--env-file`	—	Read env vars from file (repeatable)

# Deploy with auto-detection
ink deploy my-api --port 8080

# Deploy from GitHub
ink deploy my-app --repo username/repo --host github --port 3000

# Deploy a static site
ink deploy docs --buildpack static --publish-dir dist

# Deploy with environment variables
ink deploy my-api --port 8080 --env NODE_ENV=production --env-file .env

`ink redeploy`

Rebuild and redeploy an existing service. Accepts the same configuration flags as ink deploy to update settings.

ink redeploy <name> [flags]

# Redeploy with updated memory
ink redeploy my-api --memory 512Mi

# Redeploy with new env vars (merged with existing)
ink redeploy my-api --env NEW_VAR=value

# Replace all env vars instead of merging
ink redeploy my-api --env-file .env.new --replace

`ink services`

List all services, or show details for a specific service.

ink services              # List all
ink service <name>        # Show details

Aliases: ls, service

`ink status`

Show detailed service information with optional logs and metrics.

ink status <name> [flags]

Flag	Default	Description
`-e`	—	Show environment variables
`--deploy-logs`	—	Number of deploy log lines
`--runtime-logs`	—	Number of runtime log lines
`--metrics`	—	Time range: `1h`, `6h`, `24h`, `7d`, `30d`

ink status my-api -e --runtime-logs 50 --metrics 1h

`ink logs`

View build or runtime logs.

ink logs <name> [flags]

Flag	Default	Description
`-n`	`100`	Number of log lines
`--deploy`	—	Show deploy/build logs instead of runtime

ink logs my-api -n 200
ink logs my-api --deploy

`ink delete`

Permanently delete a service.

ink delete <name> [-y]

Environment Variables

`ink secret set`

Set non-sensitive environment variables.

ink secret set <service> KEY=value [KEY=value ...]

`ink secret import`

Import variables from a file. Preferred for sensitive values — avoids shell history exposure.

ink secret import <service> --file .env [--replace]

`ink secret list`

List current environment variables for a service.

ink secret list <service>

`ink secret unset`

Remove a single variable.

ink secret unset <service> KEY

`ink secret delete`

Remove multiple variables.

ink secret delete <service> KEY1 KEY2 [--replace]

Aliases: secrets, env

Templates

`ink template`

List or search available templates.

ink template              # List all templates
ink template [search]     # Search templates by keyword

Aliases: templates

`ink template info`

View template details including variables, services, and example deploy commands.

ink template info <slug>

ink template info postgres
ink template info redis

`ink template deploy`

Deploy a template. Creates all services with auto-generated credentials and returns connection info.

ink template deploy <slug> --name <name> [flags]

Flag	Default	Description
`--name`	—	Instance name (required)
`--var`	—	Template variable as KEY=VALUE (repeatable)

# Deploy PostgreSQL
ink template deploy postgres --name mydb

# Deploy with variables
ink template deploy postgres --name mydb --var database_name=myapp --var storage_gi=20

# Deploy Redis
ink template deploy redis --name cache

Missing required variables are prompted interactively.

Available database templates

Slug	Database	Default Resources
`postgres`	PostgreSQL 17	512Mi memory, 0.5 vCPU, 10 Gi volume
`postgres-pgvector`	PostgreSQL 17 + pgvector	512Mi memory, 0.5 vCPU, 10 Gi volume
`redis`	Redis 7	512Mi memory, 0.5 vCPU, 10 Gi volume
`mysql`	MySQL 8	512Mi memory, 0.5 vCPU, 10 Gi volume
`mongodb`	MongoDB 7	512Mi memory, 0.5 vCPU, 10 Gi volume

Run ink template to see the current seeded template catalog.

Git Repositories

`ink repo create`

Create an Ink-managed git repository.

ink repo create <name>

Returns a remote URL. Add it to your local repo:

git remote add ink <remote-url>
git push ink main

Pushing to an Ink repo auto-triggers deployment.

Aliases: repos

Custom Domains

`ink domain add`

Attach a custom domain to a service.

ink domain add <service> <domain>

Requires the domain's DNS zone to be delegated to Ink first. See Domains & DNS.

`ink domain remove`

Remove a custom domain.

ink domain remove <service>

Aliases: domains

DNS

`ink dns zones`

List all DNS zones.

ink dns zones

`ink dns records`

List records for a zone.

ink dns records <zone>

`ink dns add`

Create a DNS record.

ink dns add <zone> <name> <type> <content> [--ttl 300]

Supported types: A, AAAA, CNAME, MX, TXT, CAA.

`ink dns delete`

Delete a DNS record.

ink dns delete <zone> <record-id>

Projects

`ink project`

List or manage projects.

ink projects              # List all projects

Aliases: projects, proj

Workspaces

`ink workspace`

List workspaces.

ink workspace

`ink workspace create`

ink workspace create <name> <slug> [--description "..."]

`ink workspace members`

ink workspace members <slug>

`ink workspace invite`

ink workspace invite <slug> <user> [role]

Roles: member (default), admin.

`ink workspace accept-invite`

ink workspace accept-invite <id>

Other workspace commands

ink workspace delete <slug>
ink workspace invites [slug]
ink workspace decline-invite <id>
ink workspace revoke-invite <id>
ink workspace remove-member <slug> <user-id>

Aliases: workspaces, ws

Account

`ink whoami`

Show account info, plan, and GitHub connection status.

ink whoami

Alias: account

Configuration

`ink config set`

Set a default value.

ink config set workspace my-team
ink config set project backend

`ink config show`

Display the current configuration with source locations.

ink config show

Chat

`ink chat`

Send or read messages in a workspace.

ink chat

Command Reference

On this page