Skip to content
Chisel

Getting Started

Welcome to Chisel! This guide will get you up and running in less than 5 minutes.

Installation

Section titled “Installation”

Chisel is distributed as a single binary. Install it using our shell script:

Terminal window
curl -sL https://install.chisel.build | sh

Initializing your first Workspace

Section titled “Initializing your first Workspace”

Navigate to any project (e.g., a Rust repo, a web app, or a folder of notes) and run:

Terminal window
chisel init

This command creates a .chisel/ directory with docs and specs subdirectories, and populates them with helpful onboarding documentation and an initial spec.

Exploration

Section titled “Exploration”

1. Launch the Docs Explorer

Section titled “1. Launch the Docs Explorer”
Terminal window
chisel docs

Use j/k to navigate and Tab to switch between categories and the preview pane.

2. View Your Specs

Section titled “2. View Your Specs”
Terminal window
chisel spec list

Create a new spec with chisel spec new or move one through its lifecycle with chisel spec status.

Next Steps

Section titled “Next Steps”