Skip to content

Commit db4712d

Browse files
docs: add AGENTS.md
1 parent 203e8fb commit db4712d

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# devforge-cli
2+
3+
## Purpose
4+
DevForge CLI meta-package that installs all 11 developer tools in one command. Provides a unified `devforge` CLI entry point delegating to sub-tools: api-contract-guardian, json2sql, deploydiff, configdrift, apighost, apiauth, envault, schemaforge, click-to-mcp, and deadcode.
5+
6+
## Build & Test Commands
7+
- Install: `pip install -e .[all]` or `pip install devforge`
8+
- Install all tools: `pip install devforge[all]`
9+
- Test: `pytest tests/` (or `python -m pytest tests/ -v --tb=short`)
10+
- Lint: `ruff check .`
11+
- Build: `pip install build twine && python -m build && twine check dist/*`
12+
- CLI check: `devforge --help`
13+
14+
## Architecture
15+
Key directories:
16+
- `src/devforge/` — Main package (CLI dispatcher, version management)
17+
- `tests/` — Test suite
18+
- `.github/workflows/` — CI/CD pipelines
19+
20+
## Conventions
21+
- Language: Python 3.10+
22+
- Test framework: pytest
23+
- Linting: ruff
24+
- Build system: setuptools with src/ layout
25+
- CLI entry point: `devforge.cli:app`
26+
- Optional dependency groups: guard, sql, deploy, drift, ghost, auth, envault, schema, mcp, deadcode, all
27+
- Default branch: main

0 commit comments

Comments
 (0)