Skip to content

Update spx #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ab-10 merged 2 commits into from
Nov 21, 2025
+24 −12
Merged

Update spx #20

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7abc849
spx: config and merged gen into build
ab-10 Nov 20, 2025
da72d81
Merge branch 'main' into update-spx
ab-10 Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 24 additions & 12 deletions docs/spx/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,24 @@ my-spx-project/
├── .spx/ # Internal spx metadata (don't edit)
│ └── prev_specs/ # Tracks changes between generations
├── out/ # Generated code appears here (auto-created on first gen)
├── project.spx.toml # Project configuration file
└── .gitignore # Pre-configured to ignore generated files
```

The `spx init` command will interactively prompt you for:
- Project name
- Location of the `claude` binary (defaults to `~/.local/bin/claude`)

This information is saved in `project.spx.toml`:
```toml
[project]
name = "microservice-footgun"
version = "0.1.0"

[spx]
claude_code_bin = "~/.local/bin/claude"
```

**What each directory does:**

- **`specs/`** - Where you write your system specifications in markdown. All `.md` files here are read by spx.
Expand All @@ -105,29 +120,27 @@ Principles for writing effective specs:
3. **Out of scope:** explicitly state what's out of scope for now and the limitations you're fine with at the current stage.


#### `spx gen`
#### `spx build`

Once your spec is ready, generate the code:
Once your spec is ready, build your system:
```bash
spx gen
spx build
```

This command:
- Reads all markdown files from `specs/`
- Compares them with the previous generation (if any)
- Uses Claude Code CLI to generate or update code in `out/`
- Creates/updates `out/build.sh` and `out/run.sh` scripts

**First time:** Generates everything from scratch.

**Subsequent runs:** Only updates what changed in your specs, preserving what still matches.

#### `spx build

- Runs `out/build.sh` to build the generated code
- Sets up language-specific environments (virtualenv for Python, npm install for TypeScript, etc.)
- Installs required libraries
- Compiles code if necessary (e.g., for Rust or TypeScript)

**First time:** Generates everything from scratch and builds it.

**Subsequent runs:** Only updates what changed in your specs, preserving what still matches, then rebuilds

#### `spx run`

Executes your generated system.
Expand All @@ -146,8 +159,7 @@ You control your system architecture and behavior through specs, not by writing
## Commands Reference

- `spx init` - Initialize a new spx project
- `spx gen` - Generate/update implementation code from specs
- `spx build` - Build the generated code and install dependencies
- `spx build` - Generate/update implementation code from specs and build it
- `spx run [args]` - Execute your system (forwards args to your application)
- `spx clean` - Remove all generated code and build artifacts

Expand Down