Skip to main content
Version: 0.12

Command-Line

This is the command-line reference for the ChiselStrike chisel command-line interface and the chiseld server.

CLI

The command-line interface (CLI) is the main program you use to interact with ChiselStrike during development.

Overview of commands

  • apply - apply state
  • delete - delete state
  • describe - describe state
  • dev - start development server
  • help - print help
  • init - create a new project in current directory
  • new - create a new project
  • start - start server
  • status - show server status
  • wait - wait for server to start

chisel apply

Applies the contents of the current project to the ChiselStrike server.

The chisel apply locates files based on the settings in your manifest file.

See also:

chisel delete

TODO

chisel describe

The chisel describe command displays the current state of the running ChiselStrike server: models, endpoints, and policies.

chisel dev

Start the ChiselStrike server in development mode. In this mode, the CLI watches for filesystem changes in the current project, and performs apply automatically.

See also:

chisel help [COMMAND]

Prints a help message or the help of the given COMMAND.

chisel init

Create a new ChiselStrike project in current directory.

Example:

$ chisel init
Created ChiselStrike project in /.../hello

See also:

chisel new [PATH]

Create a new ChiselStrike project in PATH directory.

Example:

$ chisel new hello
Created ChiselStrike project in hello

See also:

chisel start

Starts the ChiselStrike server.

chisel status

Show status of the ChiselStrike server.

Example:

$ chisel status
Server status is OK

See also:

chisel wait

Wait for the ChiselStrike server to start up. The chisel wait exits only when the server is up and running, or the command times out.

$ chisel wait

Manifest files

The CLI parses a manifest file Chisel.toml, which has the following format:

models = ["models"]
endpoints = ["endpoints"]
policies = ["policies"]

Server

The chiseld program is the ChiselStrike server daemon. For development purposes, you don't need to interact with it.

--api-listen-addr [ADDR]

The API listen address of the server. This is the address that servers ChiselStrike endpoints.

--data-db-uri [URI]

The database URI to connect to.

--executor-threads [COUNT]

The number of executor threads the ChiselStrike server uses.

--internal-routes-listen-addr [ADDR]

The internal routes listen address of the server. This is the address that serves healthcheck for things like k8s.

--rpc-listen-addr [ADDR]

The RPC listen address of the server. This is the address that the ChiselStrike CLI connects to to interact with the server.