CLI

Last updated 4 months ago

Amber has a built in CLI tool, to make your life easier while developing applications.

Here is a list of the available commands:

  • db, database - Performs database maintenance tasks

  • e, encrypt - Encrypts environment YAML file. [env | -e --editor | --noedit]

  • x, exec - Executes Crystal code within the application scope

  • g, generate - Generate Amber classes

  • n, new - Generates a new Amber project

  • routes - Prints all defined application routes

  • w, watch - Starts amber development server and rebuilds on file changes

Read a long this guide to learn more about these command and how much time and efficient it can make your development experience.

Getting Command Help

You can get help from each command by running -h or --help next to the command

Eg.

$ amber --help

This will output to your shell the following documentation.

amber [OPTIONS] SUBCOMMAND
Amber - Command Line Interface
The `amber new` command creates a new Amber application with a default
directory structure and configuration at the path you specify.
You can specify extra command-line arguments to be used every time
`amber new` runs in the .amber.yml configuration file in your project
root directory
Note that the arguments specified in the .amber.yml file does not affect the
defaults values shown above in this help message.
Usage:
amber new [app_name] -d [pg | mysql | sqlite] -t [slang | ecr] -m [granite, crecto] --deps
Subcommands:
db, database # Performs database maintenance tasks
e, encrypt # Encrypts environment YAML file. [env | -e --editor | --noedit]
x, exec # Executes Crystal code within the application scope
g, generate # Generate Amber classes
n, new # Generates a new Amber project
routes # Prints all defined application routes
w, watch # Starts amber development server and rebuilds on file changes
Options:
-d, --database # Preconfigure for selected database. Options: pg | mysql | sqlite (default: pg)
-m, --model # Preconfigure for selected model. Options: granite | crecto (default: granite)
-t, --template # Preconfigure for selected template engine. Options: slang | ecr (default: slang)
-h, --help # Describe available commands and usages
-v, --version # Prints Amber version
Example:
amber new ~/Code/Projects/weblog
This generates a skeletal Amber installation in ~/Code/Projects/weblog.

Usage

amber new [your_app] -d [pg | mysql | sqlite] -t [slang | ecr] --deps
cd [your_app]

Options

  • -d defaults to pg

  • -t defaults to slang

  • --deps will run crystal deps for you.