https://github.com/nitrictech/cli

Nitric CLI. Manage and run Nitric apps locally and deploy to any cloud.
https://github.com/nitrictech/cli

aws azure cli cloud gcp go golang grpc nitric node-js python serverless

Last synced: about 9 hours ago
JSON representation

Nitric CLI. Manage and run Nitric apps locally and deploy to any cloud.

• Host: GitHub
• URL: https://github.com/nitrictech/cli
• Owner: nitrictech
• License: apache-2.0
• Created: 2021-12-08T01:28:48.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T04:15:52.000Z (7 months ago)
• Last Synced: 2024-04-12T15:06:01.118Z (7 months ago)
• Topics: aws, azure, cli, cloud, gcp, go, golang, grpc, nitric, node-js, python, serverless
• Language: Go
• Homepage: https://nitric.io
• Size: 3.89 MB
• Stars: 23
• Watchers: 3
• Forks: 9
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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](https://github.com/nitrictech/nitric).

## Installation

The Nitric CLI is free to [download and install](https://nitric.io/docs/installation).

## 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

```bash

nitric new --help

```

## Complete Reference

Documentation for all available commands:

- 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](https://github.com/nitrictech/nitric/discussions)

- Join us on [Discord](https://discord.gg/Webemece5C)

- Find us on [Twitter](https://twitter.com/nitric_io)

- Send us an [email](mailto:[email protected])

## Get Started

Check out the [Nitric docs](https://nitric.io/docs) to see how to get started using Nitric.

lto:[email protected])

## Get Started

Check out the [Nitric docs](https://nitric.io/docs) to see how to get started using Nitric.