CLI Reference

# Log in
formal auth login

# Get your credentials (for direct connections)
formal auth credentials

formal ls

# Connect to a database
formal connect production-postgres

# Output:
# Connected to production-postgres on localhost:6432

# PostgreSQL
psql -h localhost -p 6432 -d postgres

# MySQL
mysql -h localhost -P 4306 -D mysql

# MongoDB
mongosh "mongodb://localhost:37017/mydb"

# uses the database name from the config file in ~/.formal/config.toml
formal connect --launch production-postgres

# PostgreSQL with the "readonly" Native User label
psql -h localhost -p 6432 -U formal@readonly

# Connect to the "postgres-reader" hostname on the production-postgres resource
formal connect production-postgres@postgres-reader

# PostgreSQL
psql -h localhost -p 6432 -d postgres

# MySQL
mysql -h localhost -P 4306 -D mysql

formal disconnect production-postgres@postgres-reader

# List resources
formal ls
# Select an SSH resource and press enter

# START FORMAL-MANAGED BLOCK
# Do not hand-edit this section.
Include ~/.formal/ssh_config
# END FORMAL-MANAGED BLOCK

# Configure kubectl
formal ls
# Select a Kubernetes resource and press enter

# Disconnect from a resource
formal disconnect production-postgres

formal decrypt --ciphertext "formalencrypt:second:third:fourth:fifth"

formal s3 ls s3://my-bucket