Skip to content

Commit 6e73a76

Browse files
committed
write(AXEL.md): edit
1 parent c1ed7d7 commit 6e73a76

1 file changed

Lines changed: 72 additions & 0 deletions

File tree

AXEL.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
workspace: surfpool
3+
4+
skills:
5+
- path: ./skills
6+
- path: ~/.config/axel/skills
7+
8+
layouts:
9+
panes:
10+
- type: claude
11+
color: gray
12+
skills:
13+
- "*"
14+
15+
- type: codex
16+
color: green
17+
skills:
18+
- "*"
19+
20+
- type: custom
21+
name: shell
22+
notes:
23+
- "$ cargo build"
24+
- "$ cargo test"
25+
- "$ cargo run -- --help"
26+
27+
grids:
28+
default:
29+
type: tmux
30+
claude:
31+
col: 0
32+
row: 0
33+
width: 50
34+
shell:
35+
col: 1
36+
row: 0
37+
color: yellow
38+
---
39+
40+
# surfpool
41+
42+
Surfpool is a Solana development toolkit that provides a local validator environment, CLI tools, MCP server, GraphQL API, and a studio UI for building and testing Solana programs.
43+
44+
## Overview
45+
46+
Rust workspace with 9 crates: `cli` (main entry point), `core` (runtime), `mcp` (MCP server), `gql` (GraphQL API), `studio` (web UI), `subgraph` (indexing), `db` (storage), `types` (shared types), and `bench` (benchmarks).
47+
48+
## Getting Started
49+
50+
```bash
51+
cargo build # Build all crates
52+
cargo run -- --help # Run the CLI
53+
cargo test # Run tests
54+
```
55+
56+
## Architecture
57+
58+
- **crates/cli** - Command-line interface (default member)
59+
- **crates/core** - Core Solana runtime and validator logic
60+
- **crates/mcp** - Model Context Protocol server
61+
- **crates/gql** - GraphQL API (juniper + actix-web)
62+
- **crates/studio** - Web-based studio UI
63+
- **crates/subgraph** - Subgraph/indexing support
64+
- **crates/db** - Database layer (diesel)
65+
- **crates/types** - Shared type definitions
66+
- **crates/bench** - Benchmarking
67+
68+
## Key Files
69+
70+
- `Cargo.toml` - Workspace root with all dependency versions
71+
- `crates/cli/src/main.rs` - CLI entry point
72+
- `crates/core/` - Core runtime logic

0 commit comments

Comments
 (0)