@teer/cli NPM | npm.io

teer-cli

Digiteer command line utility

npm i -g @teer/cli

Verify installation by running:

teer --version

If you get a write access error on Windows, you'll need to run WSL or PowerShell as Administrator.

If you don't want to install or having trouble with installation, you can use npx. See usage below.

teer <command> [...options]

Using npx:

npx @teer/cli <command> [...options]

Create a new Ruby on Rails project.

teer new-ror <site-name> [<starter-url>]

Arguments	Description
site-name	Your Ruby on Rails site name which is also used to create the project directory.
starter-url	A Ruby on Rails starter URL. Defaults to git@bitbucket.org:digiteerbit/ror-starter.git.

Create an RoR site named my-awesome-site using the git@bitbucket.org:digiteerbit/ror-starter.git.

teer new-ror my-awesome-site

teer new-ror my-ecom-site git@bitbucket.org:digiteerbit/kidlat-ror-starter.git

Create a new ReactJs project

teer new-react <site-name> [<starter-url>]

Arguments	Description
site-name	Your ReactJs site name which is also used to create the project directory.
starter-url	A ReactJs starter URL. Defaults to git@bitbucket.org:digiteerbit/react-starter.git.

Create a ReactJs site named my-awesome-site using the git@bitbucket.org:digiteerbit/react-starter.git.

teer new-react my-awesome-site

teer new-react my-ecom-site git@bitbucket.org:digiteerbit/kidlat-react-starter.git

Create a new API project

teer new-api <api-name> [<starter-url>]

Arguments	Description
api-name	Your API name which is also used to create the project directory.
starter-url	An API starter URL. Defaults to git@bitbucket.org:digiteerbit/api-starter.git.

Create an API named my-awesome-api using the git@bitbucket.org:digiteerbit/api-starter.git.

teer new-api my-awesome-api

teer new-api my-ecom-api git@bitbucket.org:digiteerbit/kidlat-api-starter.git

Execute heroku commands

teer heroku <command> [...]

commands	Description
setup	Setup RoR project. If app does not exist, it will be created if you are using Digiteer heroku account.
pg:modify	Modify PostgreSQL server plan.
pg:backup	Create and download PostgreSQL backup.

Execute aws commands

teer aws <command> [...]

commands	Description
create	Create AWS Account under Digiteer Client group.

Clone

git clone git@bitbucket.org:digiteerbit/teer-cli.git
cd teer-cli

Create your feature branch from next branch. Example: feature/new-feature-name.
```
git checkout next
git checkout -b feature/new-feature-name
```
Install packages.
```
npm i
```
On a different terminal window, run build:watch.
```
npm run build:watch
```
The script will build the project when it detects code changes.
Link this package locally so you can run it without publishing to npm.
```
npm link
```
Start coding your new feature.
Assuming you did steps 4 and 5 correctly, test your changes locally by going to any folder and running the teer command.
Create automated test for your new feature if possible.
When you're done testing locally, unlink your package.
```
npm unlink
```
Push your branch feature/new-feature-name.
Create pull request.
Nudge your peers to approve your pull request.
Wait for it to be merged.