Skip to main content

​
Overview

The Suga CLI is a powerful tool for building, developing, and managing cloud-native applications with the Suga platform.

Install Suga CLI

Install the Suga CLI on your system to get started.

​
Quick Start

# Install the CLI
brew install nitrictech/tap/suga

# Login to Suga
suga login

# Create a new project
suga new my-app

# Start development
cd my-app
suga dev

​
Commands Overview

CommandDescription
suga access-tokenGet access token
suga buildBuilds the Suga application
suga completionGenerate shell autocompletion
suga configManage CLI configuration
suga devRun the Suga application in development mode
suga editEdit the Suga application
suga generateGenerate client libraries for Suga
suga initSetup a new Suga project
suga loginLogin to Suga
suga logoutLogout from Suga
suga newCreate a new Suga project
suga teamSwitch between teams
suga templatesList available templates
suga versionPrint the Suga CLI version

​
Everyday Commands

Create Projects

Use suga new to create projects from templates or suga init to add Suga to existing apps

Visual Editor

Use suga edit to design your application architecture and configure a deployment target

Local Development

Use suga dev to run your application locally with hot reload and instant feedback

Generate Clients

Use suga generate to create type-safe client libraries for your APIs

Build Terraform

Use suga build to generate Terraform infrastructure code for your deployment target

Team Authentication

Use suga login to connect to Suga Platform

​
Global Options

  • -h, --help - Show help for any command
Use suga version to display the CLI version.

​
Getting Help

# Help for any command
suga [command] --help

# General help
suga help