$ npm install -g bastion-baas-cli
$ bastion <COMMAND>
running command...
$ bastion (-v|--version|version)
bastion-baas-cli/0.1.5 darwin-arm64 node-v16.13.0
$ bastion --help [COMMAND]
USAGE
$ bastion COMMAND
...
- AWS Account
- AWS CLI configured with your AWS Account credentials
- Node and NPM installed on your local machine
- Domain name that you own
- Make sure you have installed the AWS CLI and have given it your AWS credentials
- To install:
npm install -g bastion-baas-cli
- Run
bastion deploy
and follow the cli prompts. This will provision your initial AWS infrastructure so you can begin creating Bastion instances for your backend- Once deployed, you will be given the username and password to login to the admin application
- Login to your admin app with the credentials provided by the cli
- Create an instance and give it a name. This will become the backend for your frontend application
- Use the API key provided to connect your backend to your frontend with the Bastion SDK
- You can view usage of the Bastion SDK here: https://github.com/Bastion-BaaS/bastion-sdk
- To uninstall:
npm uninstall -g bastion-baas-cli
(does not remove your AWS infrastructure)
bastion deploy
bastion destroy
bastion help [COMMAND]
bastion config
bastion show
Deploys the initial AWS infrastructure that your Bastion instances will run on. The name must be different from any other AWS infrastructure stack you have created. You will be prompted for the following information:
- Name to give to your Bastion infrastructure
- Default is
BastionInitial
- Default is
- The AWS region you will be deploying your infrastructure to
- You will be given a list of AWS regions to choose from
- Default is
us-east-1
- The name of the domain that you would like to use for Bastion. This must be a domain you own
- The hosted zone ID of your Route 53 domain. You can find this in Route 53 in your AWS console
- The username that you would like to use to login to the Admin App. This can be whatever you like
bastion deploy
can take up to 30 minutes to provision all of your infrastructure in AWS. To check the status of your stack, you can use bastion show
. Your infrastructure will be accessible at the domain that you provided once the AWS resources have been deployed.
Destroys all of the AWS infrastructure for the name of the stack you provided in bastion deploy
. It also removes the infrastructure related to that application in your local configuration file. To see where your configuration file lives, enter bastion config
.
Upon entering this command you will be prompted for the following information:
- The name of the AWS infrastructure stack you want to delete from a list of dropdown options
- A confirmation message asking if you are sure you want to delete your infrastructure
bastion destroy
can take a few minutes to fully complete.
If you use bastion destroy
before bastion deploy
has fully provisioned your infrastructure, it will still succeed in destroying your stack resources.
Displays help for Bastion CLI commands.
USAGE
$ bastion help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
Shows the location of your local configuration file. This file contains the names and AWS regions of your infrastructure stacks. The stack name specified on bastion destroy
removes the corresponding name/region combination from this file.
Displays the status of a stack you have created with bastion deploy
. It tells you if your infrastructure is ready and if so, gives you your username, password, and the domain you can find your admin app at. You will be prompted for the name of the stack you would like to check the status of.