Interaction with the Cyndra platform is mainly done with the cyndra Command Line Interface (CLI). Some tasks, such as viewing logs, can also be done in the Cyndra Console.

After installation, you will have two commands: cyndra and cargo cyndra.

  • cyndra is used for interacting with the cyndra.dev platform.
  • cargo cyndra is used for interacting with the cyndra.rs platform.

This documentation covers the cyndra.dev platform.

To get an overview of available commands, subcommands, and options, run:

cyndra help
# or
cyndra <command> --help

​
Commands

CommandDescription
initGenerate a Cyndra project from a template
runRun a Cyndra service locally
deployDeploy a Cyndra service
deploymentManage deployments of a Cyndra service [aliases: depl]
logsView logs of a Cyndra service
projectManage projects on Cyndra [aliases: proj]
resourceManage resources [aliases: res]
certificateManage SSL certificates for custom domains [aliases: cert]
accountShow info about your Cyndra account [aliases: acc]
loginLogin to the Cyndra platform
logoutLog out of the Cyndra platform
generateGenerate shell completions and man page
feedbackOpen an issue on GitHub and provide feedback
upgradeUpgrade the cargo-cyndra binary
helpPrint this message or the help of the given subcommand(s)

​
Cookbook / Cheat Sheet

These are some useful sequences of commands that are handy to keep in your back pocket. For full documentation, use --help on the respective command. Use the global --debug flag to print detailed debug output.

​
Get started

  • cargo install cargo-cyndra: For more alternatives, see Installation.
  • cyndra login: Log in via the Cyndra Console.
  • cyndra init: Generate a project from a template.
  • cyndra account: Check account details.

​
Local run

For more tips, see Local Run.

  • cyndra run: Run the project locally so you can test your changes.
  • cyndra run --port 8080: Change the local port.
  • cyndra run --port 8080 --external: Expose to local network by listening on 0.0.0.0.
  • cyndra run --secrets <file>: Use a non-default secrets file for this run.
  • cyndra run --release: Compile with release mode.
  • cyndra run --bacon: Run in watch mode, requires separate install of bacon.

​
Deploy a project

  • cyndra project create: Create a project on Cyndra.
  • cyndra deploy: Deploy the project to Cyndra.
  • cyndra deploy --no-follow: Don’t poll deployment state. Alias: --nf.
  • cyndra deploy --secrets <file>: Use a non-default secrets file for this deployment. It must be located in the same folder that Secrets.toml should be in.

​
Manage projects

All project-related commands can use:

  • --working-directory <path> or --wd <path> to execute the command in a different folder.
  • --name <name> to specify project name explicitly (see Project).
  • --id <id> to specify project id explicitly (see Project).
  • cyndra project list: List your projects.
  • cyndra project status: Check the state of this project.
  • cyndra project link: Link this project folder to a project on Cyndra.
  • cyndra project delete: Delete a project.
  • cyndra project update name <new-name>: Rename a project and its default subdomain.

​
Manage deployments and logs

  • cyndra deployment list: List deployments in this project.
  • cyndra deployment status: Show status of the currently running deployment.
  • cyndra deployment stop: Stop any currently running deployments.
  • cyndra deployment redeploy: Redeploy the latest deployment without building.
  • cyndra deployment redeploy [id]: Redeploy the specified deployment id without building.
  • cyndra logs: Get all logs from the currently running deployment.
  • cyndra logs --latest: Get all logs from the latest deployment.
  • cyndra logs <id>: Get all logs from a specific deployment.
  • cyndra logs --raw: Print the logs without timestamps and origin tags. The --raw flag is also available for the run and deploy commands.

​
Manage resources

  • cyndra resource list: List resources linked to this project.
  • cyndra resource delete <type>: Delete a resource such as databases and secrets.

​
Shell completions

Use cyndra generate shell <shell> with one of: bash, elvish, fish, powershell, zsh.

Example configuration for Zsh on Linux: add eval "$(cyndra generate shell zsh)" to ~/.zshrc.

​
Utility

  • cyndra <command> --debug: Turn on tracing output for Cyndra libraries. (WARNING: can print sensitive data)
  • cyndra deploy --output-archive <path>: Dump the deployment archive to disk instead of deploying it. Useful for debugging.
  • cyndra logout --reset-api-key: Log out and reset your account’s API key.