Перейти к содержимому

Поиск по документации

Поиск по документации Skiffly

Команды CLI

Every `skiffly` command with its flags. Global target flags `-p/--project`, `-e/--environment`, `-s/--service` accept an id or a name.

Install with npm i -g skiffly (Node.js 20+). The CLI guide walks through the workflow; this page is the complete list.

Auth#

CommandDescription
login [--token <t>]Save a token (prompts when omitted) to ~/.config/skiffly/config.json
logoutForget the token
whoamiCurrent user and workspaces

Projects and linking#

CommandDescription
listProjects across your workspaces
init [--name <n>] [--workspace <id>]Create a project and link the current directory
link [project] [-p] [-e] [-s]Link the directory to a project / environment / service
unlinkRemove the link
statusLinked target plus every service's deployment status and domains
open [--print]Open the linked project or service in the dashboard
environment [name]Switch the linked environment
environment listList environments
environment new <name> [--duplicate <env>]Create an environment, optionally copying variables and settings
service [name]Link a service
service listList services
service deleteDelete the linked service

Deploying#

CommandDescription
up [path] [-d] [-c] [-y] [--commit <sha>]Deploy the pushed HEAD of the current branch; -d detach, -y create the service without asking
redeployRe-run the latest build
restartRestart containers in place
deploy --image <image> [--name <n>] [--port <p>] [-v K=V …]Create an image service, or change the linked service's image
deploy --template <code> [-v K=V] [-v Service.K=V]Deploy a template
deploy-template <code> …Alias of the above
deployment listRecent deployments

Logs and shell#

CommandDescription
logs [deploymentId] [-b|--build] [-d|--deploy] [--system] [-f] [-n <N>] [--filter <text>]Logs; -f polls every 2 s
ssh [-s] [-e] [--deployment <id>] [-T] [-- cmd…]Shell or one-off command in a running container; -T no pseudo-terminal
shellAlias of ssh
run [-s] [-e] -- <cmd>Run a local command with the service's variables in the environment

Variables#

CommandDescription
variables [list] [--kv] [--shared]List (aliases variable, vars, var)
variables set K=V … [--stdin K] [--shared] [--skip-deploys]Set; redeploys unless --skip-deploys
variables delete K …Delete

Networking#

CommandDescription
domainGenerate a *.skiffly.cloud domain (or print the existing one)
domain <custom.domain>Add a custom domain; prints CNAME and TXT records
domain listDomains of the service
domain status <domain>Re-check DNS and verification
domain delete <domain>Remove a domain
proxy listTCP proxies
proxy add --port <p>Expose a container port on edge.skiffly.cloud:2xxxx
proxy delete <id|port>Remove a proxy
connect [service] [-y] [--print]Open psql / mysql / redis-cli / mongosh through a proxy

Volumes, templates, billing#

CommandDescription
volume listVolumes of the environment
volume add --mount-path <path> [--size <GB>]Create a volume on the linked service
templates [search] [--category <c>] [--featured]Browse the catalog
billing (alias usage)Balance, plan, current usage

Config as code#

CommandDescription
config initWrite .skiffly/skiffly.ts from the linked environment
config validateEvaluate the file without API calls
config plan [--prune] [--json] [--show-secrets] [-f <file>]Preview the diff
config apply [--yes] [--prune] [--no-deploy] [-f <file>]Apply the diff and deploy changed services

MCP, docs, raw API#

CommandDescription
mcpRun the MCP server over stdio
mcp toolsPrint the tool list
mcp install claude|cursor|codexRegister the server with the client
docs [query]Open the docs, or search the bundled docs
api '<query>' [-v '<json>']Raw GraphQL request with the saved token

Environment variables#

VariableMeaning
SKIFFLY_TOKENToken; overrides the saved login
SKIFFLY_PROJECT_ID, SKIFFLY_ENVIRONMENT_ID, SKIFFLY_SERVICE_IDOverride the directory link
SKIFFLY_API_URLGraphQL endpoint (default https://api.skiffly.dev/graphql)
SKIFFLY_CONFIG_DIR, XDG_CONFIG_HOMEWhere the config file lives
SKIFFLY_DEBUG=1Stack traces on errors

Exit codes#

0 ok · 1 error · 2 usage or not linked · 3 not authenticated · 4 not found · 5 forbidden or plan limit · 6 network. Every list command supports --json.