Skip to content

Commit 68aef95

Browse files
committed
docs: add AGENTS.md for agentic coding agents
Provides build/dev/test commands, code style guidelines, and architecture overview for AI coding assistants working in this repository.
1 parent f4fb2c5 commit 68aef95

2 files changed

Lines changed: 24 additions & 1 deletion

File tree

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ src-tauri/binaries/
2929
temp_lib/
3030

3131
.cursor/
32-
AGENTS.md
3332
CLAUDE.md
3433
*_TASK.md
3534

AGENTS.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Agent Guidelines for Opcode
2+
3+
## Build & Dev Commands
4+
- `bun install` - Install dependencies
5+
- `bun run dev` - Start Vite dev server (frontend only)
6+
- `bun run tauri dev` - Full Tauri development mode
7+
- `bun run build` - Build frontend (`tsc && vite build`)
8+
- `bun run tauri build` - Production build
9+
- `bun run check` - TypeScript + Rust check (`tsc --noEmit && cargo check`)
10+
- `cd src-tauri && cargo test` - Run Rust tests
11+
- `cd src-tauri && cargo fmt && cargo clippy` - Format and lint Rust
12+
13+
## Code Style
14+
- **TypeScript**: Strict mode, no unused vars/params, ES2020 target, React JSX
15+
- **Rust**: Edition 2021, use `cargo fmt` before commits, address `clippy` warnings
16+
- **Imports**: Use `@/*` path alias for `./src/*` in TypeScript
17+
- **Naming**: camelCase (TS), snake_case (Rust), PascalCase for types/components
18+
- **Errors**: Use `Result<T, String>` in Rust commands, try/catch in TS async functions
19+
20+
## Architecture
21+
- Frontend: React + TypeScript + Vite in `src/`
22+
- Backend: Tauri + Rust in `src-tauri/src/`
23+
- Tauri commands in `src-tauri/src/commands/` expose Rust to frontend via `invoke()`
24+
- Use `#[cfg(windows)]` / `#[cfg(unix)]` for platform-specific code

0 commit comments

Comments
 (0)