Skip to content

Commit 00fecc7

Browse files
committed
docs: add docs for docs site
1 parent c89e802 commit 00fecc7

14 files changed

Lines changed: 1076 additions & 0 deletions

File tree

docs/commands/completion.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# mold completion
2+
3+
Generate shell completion scripts.
4+
5+
## Usage
6+
7+
```sh
8+
mold completion <shell>
9+
```
10+
11+
## Supported shells
12+
13+
### Bash
14+
15+
Add to `~/.bashrc`:
16+
17+
```sh
18+
eval "$(mold completion bash)"
19+
```
20+
21+
Then restart your shell or run `source ~/.bashrc`.
22+
23+
### Zsh
24+
25+
Add to `~/.zshrc`:
26+
27+
```sh
28+
eval "$(mold completion zsh)"
29+
```
30+
31+
Then restart your shell or run `source ~/.zshrc`.
32+
33+
### Fish
34+
35+
```sh
36+
mold completion fish > ~/.config/fish/completions/mold.fish
37+
```
38+
39+
Then restart your shell or start a new session.
40+
41+
## What gets completed
42+
43+
Shell completions work for:
44+
45+
- All commands and subcommands
46+
- Flag names (`--stack`, `--tools`, `--kit`, etc.)
47+
- Flag values (kit names, stack names, tool names)

docs/commands/config.md

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# mold config
2+
3+
Manage mold's global configuration.
4+
5+
## Usage
6+
7+
```sh
8+
mold config <subcommand> [args]
9+
```
10+
11+
## Subcommands
12+
13+
### `config set`
14+
15+
Set a configuration value.
16+
17+
```sh
18+
mold config set <key> <value>
19+
```
20+
21+
### `config get`
22+
23+
Read a single configuration value.
24+
25+
```sh
26+
mold config get <key>
27+
```
28+
29+
### `config list`
30+
31+
Show all configuration values.
32+
33+
```sh
34+
mold config list
35+
```
36+
37+
### `config reset`
38+
39+
Restore all settings to defaults.
40+
41+
```sh
42+
mold config reset
43+
```
44+
45+
## Valid keys
46+
47+
| Key | Default | Description |
48+
|-----|---------|-------------|
49+
| `default_kit` | `original` | Kit used when `--beads`/`--kit` is not passed |
50+
| `default_stack` | `bare` | Stack used when `--stack` is not passed |
51+
| `author` | (empty) | Author name injected into templates |
52+
| `git_init` | `true` | Whether `mold new` runs `git init` |
53+
| `tools` | `claude` | Comma-separated default AI tools |
54+
55+
## Examples
56+
57+
Set your default stack and tools:
58+
59+
```sh
60+
mold config set default-stack go
61+
mold config set tools claude,cursor,aider
62+
```
63+
64+
Check the current default kit:
65+
66+
```sh
67+
mold config get default-kit
68+
```
69+
70+
```
71+
original
72+
```
73+
74+
List all settings:
75+
76+
```sh
77+
mold config list
78+
```
79+
80+
```
81+
default_kit = original
82+
default_stack = bare
83+
author =
84+
git_init = true
85+
tools = claude
86+
```
87+
88+
Reset everything:
89+
90+
```sh
91+
mold config reset
92+
```
93+
94+
## Config file location
95+
96+
Configuration is stored at `~/.config/mold/config.toml`. The file is created automatically on first use.
97+
98+
## See also
99+
100+
- [Configuration](../configuration.md) -- full config file reference

docs/commands/doctor.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# mold doctor
2+
3+
Check the health of an AI project setup.
4+
5+
## Usage
6+
7+
```sh
8+
mold doctor
9+
```
10+
11+
## Description
12+
13+
Inspects the current directory and verifies that AI project configuration is correct. Checks for required files, valid JSON, git initialization, and tool-specific configuration.
14+
15+
## Example
16+
17+
```sh
18+
cd my-app
19+
mold doctor
20+
```
21+
22+
```
23+
Checking project health...
24+
25+
[OK] CLAUDE.md exists
26+
[OK] .claude/settings.json exists and is valid JSON
27+
[OK] .git directory found
28+
[OK] .gitignore exists
29+
30+
Summary: 4 passed, 0 warnings, 0 errors
31+
```
32+
33+
## Exit codes
34+
35+
| Code | Meaning |
36+
|------|---------|
37+
| `0` | All checks passed |
38+
| `1` | One or more checks failed |
39+
40+
## What it checks
41+
42+
- `CLAUDE.md` exists
43+
- `.claude/settings.json` exists and contains valid JSON
44+
- `.git` directory is present
45+
- `.gitignore` exists
46+
47+
## See also
48+
49+
- [mold upgrade](upgrade.md) -- update kit files to the latest version

docs/commands/init.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# mold init
2+
3+
Add AI config to an existing project.
4+
5+
## Usage
6+
7+
```sh
8+
mold init [flags]
9+
```
10+
11+
## Description
12+
13+
Adds kit files (CLAUDE.md, settings.json, etc.) to the current working directory. Unlike `mold new`, this command does not create a new directory, initialize git, or create an initial commit.
14+
15+
## Flags
16+
17+
| Flag | Default | Description |
18+
|------|---------|-------------|
19+
| `--beads` | `false` | Use the Beads kit |
20+
| `--stack <name>` | `bare` | Tech stack template (`go`, `rust`, `next`, `bare`) |
21+
| `--tools <list>` | `claude` | Comma-separated AI tools, or `all` |
22+
| `--force` | `false` | Overwrite existing config files |
23+
| `--dry-run` | `false` | Preview without writing files |
24+
25+
## Examples
26+
27+
Add Original kit to current directory:
28+
29+
```sh
30+
mold init
31+
```
32+
33+
Add Beads kit with extra AI tool files:
34+
35+
```sh
36+
mold init --beads --tools copilot,gemini
37+
```
38+
39+
Overwrite existing config files:
40+
41+
```sh
42+
mold init --force
43+
```
44+
45+
Preview changes:
46+
47+
```sh
48+
mold init --dry-run
49+
```
50+
51+
## Behavior
52+
53+
1. Scans the current directory for conflicting files
54+
2. If conflicts exist and `--force` is not set, lists them and exits
55+
3. Renders kit, stack, and tool template files into the current directory
56+
4. Does **not** run `git init` or create commits
57+
58+
## See also
59+
60+
- [mold new](new.md) -- create a brand new project

docs/commands/kit.md

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# mold kit
2+
3+
Manage project scaffolding kits.
4+
5+
## Usage
6+
7+
```sh
8+
mold kit <subcommand> [args]
9+
```
10+
11+
## Subcommands
12+
13+
### `kit list`
14+
15+
List all available kits (built-in and custom).
16+
17+
```sh
18+
mold kit list
19+
```
20+
21+
```
22+
Available kits:
23+
beads Git-backed issue tracking via bd CLI
24+
original Standard Claude Code workflow (default)
25+
```
26+
27+
### `kit info`
28+
29+
Show detailed information about a kit, including all files it generates.
30+
31+
```sh
32+
mold kit info <name>
33+
```
34+
35+
```sh
36+
mold kit info original
37+
```
38+
39+
```
40+
Kit: original
41+
Description: Standard Claude Code workflow
42+
43+
Files:
44+
CLAUDE.md
45+
.claude/settings.json
46+
docs/TODO.md
47+
.repomixignore
48+
repomix.config.json
49+
.claude/commands/review.md
50+
.claude/commands/test.md
51+
.claude/commands/doc.md
52+
.claude/commands/refactor.md
53+
```
54+
55+
### `kit add`
56+
57+
Register a custom kit from a local directory.
58+
59+
```sh
60+
mold kit add <path>
61+
```
62+
63+
The directory must contain a `kit.toml` file:
64+
65+
```toml
66+
name = "my-kit"
67+
description = "My custom project template"
68+
```
69+
70+
### `kit remove`
71+
72+
Unregister a custom kit.
73+
74+
```sh
75+
mold kit remove <name>
76+
```
77+
78+
## Custom kits
79+
80+
Custom kits let you define your own project templates. Create a directory with:
81+
82+
1. A `kit.toml` metadata file (required)
83+
2. Template files that will be rendered into new projects
84+
85+
Register it:
86+
87+
```sh
88+
mold kit add ~/my-kits/react-kit
89+
```
90+
91+
Use it:
92+
93+
```sh
94+
mold new my-app --kit react-kit
95+
```
96+
97+
Set it as default:
98+
99+
```sh
100+
mold config set default-kit react-kit
101+
```
102+
103+
Remove it:
104+
105+
```sh
106+
mold kit remove react-kit
107+
```
108+
109+
## See also
110+
111+
- [Kits](../concepts/kits.md) -- what kits are and how they work

0 commit comments

Comments
 (0)