cli

README

CLI for building and deploying nitric apps

Overview

Nitric provides a command-line interface (CLI) to assist with various tasks when building applications with the Nitric framework. For more information, check out the main Nitric repo.

Installation

The Nitric CLI is free to download and install.

Purpose

The Nitric CLI performs 3 main tasks:

• Create new projects
• Run apps locally for testing and development
• Deploy to the cloud you choose

Common Commands

Common commands in the CLI that you’ll be using:

• nitric down : Undeploy a previously deployed stack, deleting resources
• nitric run : Run your project locally for development and testing
• nitric stack new [stackName] [providerName] : Create a new Nitric stack
• nitric start : Run nitric services locally for development and testing
• nitric up : Create or update a deployed stack

Help with Commands

Each command is self documented and provides a "help" interface describing the usage, arguments and options for the command. Use the help command to view the help information for any other command:

Example displaying help for the new command

nitric new --help

Complete Reference

Documentation for all available commands:

• nitric add : Add new resources to your Nitric project
• nitric add stack [stackName] [providerName] : Create a new Nitric stack
• nitric add website [websiteName] [toolName] : Add a new website to your Nitric project
• nitric build : Build a Nitric project
• nitric debug : Debug Operations (utilities for debugging nitric applications)
• nitric debug spec : Output the nitric application cloud spec. (alias: nitric spec)
• nitric new [projectName] [templateName] : Create a new project
• nitric run : Run your project locally for development and testing
• nitric stack : Manage stacks (the deployed app containing multiple resources e.g. services, buckets and topics)
• nitric stack down [-s stack] : Undeploy a previously deployed stack, deleting resources (alias: nitric down)
• nitric stack list : List all stacks in the project
• nitric stack new [stackName] [providerName] : Create a new Nitric stack
• nitric stack update [-s stack] : Create or update a deployed stack (alias: nitric up)
• nitric start : Run nitric services locally for development and testing
• nitric version : Print the version number of this CLI

Get in touch

• Ask questions in GitHub discussions

• Join us on Discord

• Find us on Twitter

• Send us an email

Get Started

Check out the Nitric docs to see how to get started using Nitric. lto:maintainers@nitric.io)

Get Started

Check out the Nitric docs to see how to get started using Nitric.