Skip to content

README.md

Latest commit

 

History

History
78 lines (52 loc) · 1.97 KB

README.md

File metadata and controls

78 lines (52 loc) · 1.97 KB

Snowclone CLI

Before using Snowclone CLI, you must do the following:

Installation

To install the Snowclone CLI, run the following command in the terminal:
npm install -g snowclone-cli

Usage

snowclone init

Initialize your AWS with the necessary admin infrastructure. 

FLAGS
  -r, --region: The AWS region
  -d, --domain: Your route-53 registered domain

EXAMPLE
  snowclone init -r us-west-1 -d myapp.com

Snowclone will prompt users for these values if flags are not present.

snowclone deploy

Deploy a new backend stack to ECS Fargate. 

FLAGS
  -n, --name: The name of the project

EXAMPLE
  snowclone deploy -n snowcones

Snowclone will prompt users for a project name if the flag is not present.

snowclone import

Import a specified sql file to a specified backend. 

FLAGS
  -n, --name: The name of the project to upload a sql file to
  -f, --filepath: The path of the sql file

EXAMPLE
  snowclone import -n snowcones -f snowconesSchema.sql

Snowclone will prompt users for a project name if the flag is not present.

snowclone list

List all active projects.

snowclone remove

Remove a specified project.

FLAGS
  -n, --name: The name of the project backend to be removed

EXAMPLE
  snowclone remove -n snowcones

Snowclone will prompt users for a project name if the flag is not present.

snowclone melt

Remove the admin infrastructure that was created with snowclone init. Note: this operation is irreversable. You will be prompted for confirmation before 'melt' proceeds. This action should only be done if all projects have been removed.