astro-cli

README

Astronomer CLI

The Astronomer CLI is the recommended way to get started developing and deploying on Astronomer Enterprise Edition.

Setup

1. Install Go:

   $ brew install go
   

   More info: https://golang.org/doc/install

2. Set GOPATH (recommended: ~/go) in .bash_profile or .bashrc:

   export GOPATH=$HOME/go
   export GOBIN=$HOME/go/bin
   export PATH=$PATH:$GOBIN
   

   More info: https://github.com/golang/go/wiki/SettingGOPATH

Quickstart

How to get started as a user.

1. Install Astro CLI:

• via curl

  curl -sL https://install.astronomer.io | sudo bash
  

• via go get

  install go binary:

  $ go get github.com/astronomerio/astro-cli
  

  Add to .bash_profile:

  alias astro=astro-cli
  

  Note: This is temporary while we have two CLIs (the older one is for current SaaS customers). Eventually this CLI will replace the old one and this step will be unncessary.

1. Run it to see commands:

   $ astro
   

2. Create a project:

   $ mkdir hello-astro && cd hello-astro
   $ astro airflow init
   

Help

The CLI includes a help command, descriptions, as well as usage info for subcommands.

To see the help overview:

$ astro help

Or for subcommands:

$ astro airflow --help

$ astro airflow create --help

Development

How to get started as a developer.

1. Build:

   $ git clone git@github.com:astronomerio/astro-cli.git
   $ cd astro-cli
   $ make build
   

2. (Optional) Install to $GOBIN:

   $ make install
   

3. Run:

   $ astro