Reference for the Sequin CLI. Learn about installation options, context management, configuration commands, and local development tunnels.
sequin context
sequin context add
--api-token
: Your authentication token--set-default
: Set as the default context--hostname
: API hostname of your Sequin instance (defaults to api.sequinstream.com)--tls
: Enable/disable TLS (enabled by default)--tunnel-ports
: Configure default tunnel portssequin context ls
sequin context select
--context
flag:
config
command group allows you to manage Sequin resources using YAML configuration files. This provides a declarative way to create and manage databases, sinks, HTTP endpoints, and other resources.
sequin config
sequin config export
- Export current configuration as YAMLsequin config plan [file]
- Preview changes from a YAML filesequin config apply [file]
- Apply changes from a YAML filesequin config interpolate
- Interpolate environment variables in a YAML filefile
argument defaults to sequin.yaml
if not specified.
--auto-approve
- Skip interactive approval for the apply
command (useful for CI/CD)--context
flag:
export
command is experimental. Exported configurations may need manual adjustments before use:account
and user
sections are not exportedtunnel
command creates a secure connection between your local development environment and Sequin’s cloud platform. You can use it to connect Sequin to either local databases or HTTP endpoints.
sequin tunnel
tunnel
command. The docs for that command:
my-pg-db
on Sequin, and it’s running on port 5432 on your local machine, run:
localhost:5432
.