This is the command-line reference for the ChiselStrike
chisel command-line interface and the
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
Applies the contents of the current project to the ChiselStrike server.
chisel apply locates files based on the settings in your manifest file.
chisel describe command displays the current state of the running ChiselStrike server: models, routes, and policies.
Start the ChiselStrike server in development mode. In this mode, the CLI watches for filesystem changes in the current project, and performs
chisel help [COMMAND]
Prints a help message or the help of the given
Create a new ChiselStrike project in current directory.
$ chisel init
Created ChiselStrike project in /.../hello
chisel new [PATH]
Create a new ChiselStrike project in
$ chisel new hello
Created ChiselStrike project in hello
Starts the ChiselStrike server.
Show status of the ChiselStrike server.
$ chisel status
Server status is OK
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
The CLI parses a manifest file
Chisel.toml, which has the following format:
models = ["models"]
routes = ["routes"]
policies = ["policies"]
chiseld program is the ChiselStrike server daemon. For development purposes, you don't need to interact with it.
The API listen address of the server. This is the address that serves ChiselStrike endpoints.
The database URI to connect to.
The number of executor threads the ChiselStrike server uses.
The internal routes listen address of the server. This is the address that serves health check for things like k8s.
The RPC listen address of the server. This is the address that the ChiselStrike CLI connects to to interact with the server.