Using snlctl

Authentication

Before using any command, authenticate with your Google account:

snlctl auth login

This opens your browser for Google SSO. After signing in, the token is saved to ~/.snl/token.json.

Check your auth status:

snlctl auth status

Command structure

snlctl <resource> <action> [flags]

Examples:

snlctl deploy list
snlctl pods get my-pod
snlctl db create --name mydb --engine postgres
snlctl domain create --name myapp --service myapp --port 3000

Global flags

Flag	Description
--json	Output raw JSON instead of tables
--quiet	Suppress non-essential output
--no-color	Disable colored output
--no-update	Skip the daily auto-update check
--api-url <url>	Override API endpoint
--token <token>	Override auth token

Common workflows

Deploy an app

# Create a deployment
snlctl deploy create --name myapp --image nginx:latest --port 80 --replicas 2

# Expose it on a subdomain
snlctl domain create --name myapp --service myapp --port 80

# Check status
snlctl status

Your app is now live at myapp.synoralab.dev.

Scale and restart

# Scale to 3 replicas
snlctl deploy scale myapp --replicas 3

# Restart (rolling)
snlctl deploy restart myapp

Create a database

# PostgreSQL (default)
snlctl db create --name mydb --engine postgres

# MySQL
snlctl db create --name mydb --engine mysql

# MongoDB
snlctl db create --name mydb --engine mongo

# Get connection credentials
snlctl db credentials mydb

Note

MongoDB external connections require tls=false in the connection string. The credentials output includes the correct URI.

Manage environment variables

# Set env vars on a deployment
snlctl env set myapp --key DATABASE_URL --value "postgres://..."

# Import from a .env file
snlctl env import myapp --file .env

# Link database credentials automatically
snlctl env link-db myapp --db mydb

View logs

# Tail logs from a pod
snlctl logs my-pod-abc123

# Logs from a specific deployment's pods
snlctl pods list   # find the pod name
snlctl logs <pod-name>

S3 storage

# Create a bucket
snlctl s3 bucket-create --name assets

# Create an access token
snlctl s3 token-create --bucket assets --permissions readwrite

# Link S3 credentials to your deployment's env
snlctl env link-s3 myapp --bucket assets

Custom domains

# Let's Encrypt (automatic TLS)
snlctl custom-domain create --domain myapp.example.com --service myapp --port 80 --tls-mode letsencrypt

# Verify DNS is set up correctly
snlctl custom-domain verify myapp.example.com

Point your domain’s CNAME to cname.synoralab.dev first.

GitHub auto-deploy

# Enable push-to-deploy
snlctl build enable --repo my-org/my-repo --name myapp --branch main

# Check recent builds
snlctl build runs <id>

If the bot doesn’t have access to your repo, the CLI will prompt you to invite @ST4RCHASER-Automation as a collaborator. After you send the invite, press Enter and it will automatically accept and retry.

Rollback

# View deployment history
snlctl deploy history myapp

# Rollback to previous revision
snlctl rollback myapp

Full command reference

Resource groups

Resource	Actions
auth	login, status, refresh, logout
deploy	create, list, get, delete, restart, scale, history
pods	list, get, status, delete
services	list, get, delete
apply	(apply k8s manifest)
exec	(exec into pod)
job	create
cronjob	create, list, get, delete
events	(show namespace events)
env	list, set, delete, import, link-db, link-s3
db	create, list, credentials, delete, backup, backups, restore
s3	bucket-create, bucket-list, bucket-delete, token-create, token-list, token-update, token-delete
domain	create, list, check, update, delete
directport	create, list, delete
custom-domain	create, list, verify, delete
pages	deploy, list, status, upload, set-domain, delete
build	enable, list, update, delete, runs, check-access, accept-invites
rollback	(rollback deployment)
logs	(view logs), archive, archives
notify	create, list, update, delete, test
share	grant, revoke, list
diagnose	(auto-diagnose issues)
autoscale	create, list, update, delete
schedule	create, list, delete
quota	get, update
status	(overview), usage, events, reset
kubeconfig	(generate kubeconfig)
template	list, deploy
admin	users, cluster, delete-user, cleanup, offboard, reprovision

Tips

• Use --json when piping output to jq or scripts
• snlctl deploy list shows the same info as kubectl get deployments
• All destructive actions (delete) ask for confirmation — use --quiet to skip in scripts
• Config is stored in ~/.snl/ — config.json for settings, token.json for auth
• You can override the API URL with SNL_API_URL env var or --api-url flag