agent-policy-cli 0.7.0__py3-none-win_amd64.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
Binary file
|
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: agent-policy-cli
|
|
3
|
+
Version: 0.7.0
|
|
4
|
+
Summary: Schema-first generator for coding-agent repo policies and compatibility files.
|
|
5
|
+
Home-page: https://github.com/CameronBrooks11/agent-policy
|
|
6
|
+
Author: Cameron Brooks
|
|
7
|
+
Author-email: cambrooks3393@gmail.com
|
|
8
|
+
License: Apache-2.0
|
|
9
|
+
Keywords: agent,policy,codegen,cli,llm
|
|
10
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
11
|
+
Classifier: Programming Language :: Rust
|
|
12
|
+
Classifier: Topic :: Software Development :: Code Generators
|
|
13
|
+
Classifier: Topic :: Utilities
|
|
14
|
+
Classifier: Environment :: Console
|
|
15
|
+
Classifier: Development Status :: 4 - Beta
|
|
16
|
+
Project-URL: Repository, https://github.com/CameronBrooks11/agent-policy
|
|
17
|
+
Project-URL: Changelog, https://github.com/CameronBrooks11/agent-policy/blob/main/CHANGELOG.md
|
|
18
|
+
Project-URL: Documentation, https://cameronbrooks11.github.io/agent-policy/
|
|
19
|
+
Requires-Python: >=3.8
|
|
20
|
+
Description-Content-Type: text/markdown
|
|
21
|
+
|
|
22
|
+
# agent-policy
|
|
23
|
+
|
|
24
|
+
Schema-first generator for coding-agent repo policies and compatibility files.
|
|
25
|
+
|
|
26
|
+
**Generates `AGENTS.md`, `CLAUDE.md`, `.cursor/rules/`, and `.windsurf/rules/` (among others) from a single `agent-policy.yaml`.**
|
|
27
|
+
|
|
28
|
+
[](https://crates.io/crates/agent-policy)
|
|
29
|
+
[](https://www.npmjs.com/package/agent-policy)
|
|
30
|
+
[](https://pypi.org/project/agent-policy-cli/)
|
|
31
|
+
[](https://docs.rs/agent-policy)
|
|
32
|
+
[](https://cameronbrooks11.github.io/agent-policy/)
|
|
33
|
+
[](https://github.com/CameronBrooks11/agent-policy/actions/workflows/ci.yml)
|
|
34
|
+
[](LICENSE)
|
|
35
|
+
|
|
36
|
+
## What it does
|
|
37
|
+
|
|
38
|
+
Maintaining `AGENTS.md`, `CLAUDE.md`, and Cursor rules separately means the same policy information gets duplicated across files that diverge over time. `agent-policy` solves this by letting you define your repo's coding-agent policy once in a canonical `agent-policy.yaml`, then generating all the tool-specific compatibility files from that single source of truth.
|
|
39
|
+
|
|
40
|
+
Keep one policy file. Generate all agent instruction files from it. Detect drift in CI.
|
|
41
|
+
|
|
42
|
+
## Install
|
|
43
|
+
|
|
44
|
+
### From npm (no Rust toolchain required)
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
npx agent-policy
|
|
48
|
+
# or install globally
|
|
49
|
+
npm install -g agent-policy
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### From PyPI (no Rust toolchain required)
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
pip install agent-policy-cli
|
|
56
|
+
# or with pipx (recommended for CLI tools)
|
|
57
|
+
pipx install agent-policy-cli
|
|
58
|
+
# or with uv
|
|
59
|
+
uv tool install agent-policy-cli
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
The PyPI package is `agent-policy-cli`; the command it installs is `agent-policy`.
|
|
63
|
+
|
|
64
|
+
### From crates.io
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
cargo install agent-policy
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Binary releases
|
|
71
|
+
|
|
72
|
+
Download pre-built binaries from [GitHub Releases](https://github.com/CameronBrooks11/agent-policy/releases).
|
|
73
|
+
|
|
74
|
+
## Quick start
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
# Create a starter policy
|
|
78
|
+
agent-policy init
|
|
79
|
+
|
|
80
|
+
# Edit agent-policy.yaml, then generate
|
|
81
|
+
agent-policy generate
|
|
82
|
+
|
|
83
|
+
# Add to CI to prevent drift
|
|
84
|
+
agent-policy check
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
## Commands
|
|
88
|
+
|
|
89
|
+
| Command | Description |
|
|
90
|
+
| -------------------------------- | ------------------------------------------------------------------------ |
|
|
91
|
+
| `agent-policy init` | Write a starter `agent-policy.yaml` in the current directory |
|
|
92
|
+
| `agent-policy list-targets` | View a table of all available export formats and their stability |
|
|
93
|
+
| `agent-policy generate` | Generate all enabled output files from `agent-policy.yaml` |
|
|
94
|
+
| `agent-policy lint` | Analyze `agent-policy.yaml` for semantic errors and warnings |
|
|
95
|
+
| `agent-policy check` | Verify committed files match the current policy (CI use) |
|
|
96
|
+
| `agent-policy install-hooks` | Install a pre-commit or pre-push git hook that runs `check` locally |
|
|
97
|
+
| `agent-policy import` | Scaffold `agent-policy.yaml` by scraping an existing `AGENTS.md` or `CLAUDE.md` |
|
|
98
|
+
|
|
99
|
+
Both `generate` and `check` accept `--config` / `-c` to specify a non-default config path, and `--targets` to natively override outputs:
|
|
100
|
+
|
|
101
|
+
```bash
|
|
102
|
+
agent-policy generate --config infra/agent-policy.yaml
|
|
103
|
+
agent-policy check --targets agents-md,clinerules
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## agent-policy.yaml
|
|
107
|
+
|
|
108
|
+
Minimal example:
|
|
109
|
+
|
|
110
|
+
```yaml
|
|
111
|
+
project:
|
|
112
|
+
name: my-project
|
|
113
|
+
summary: A short description.
|
|
114
|
+
outputs:
|
|
115
|
+
- agents-md
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
_Note: You do not need to manually add `.md` outputs or target paths to your `paths.generated` config list. Any active `outputs` are injected into your generated list automatically!_
|
|
119
|
+
|
|
120
|
+
Full example — see [`examples/website/agent-policy.yaml`](examples/website/agent-policy.yaml).
|
|
121
|
+
|
|
122
|
+
The file is validated against [`agent-policy.schema.json`](agent-policy.schema.json) (JSON Schema Draft 2020-12). The schema is bundled with the binary and is versioned alongside it. It is considered unstable until v1.0.0.
|
|
123
|
+
|
|
124
|
+
## Generated outputs
|
|
125
|
+
|
|
126
|
+
| Target ID | File | Enabled by default | Tool(s) |
|
|
127
|
+
| ----------------------------- | --------------------------------- | ------------------ | ------------------------ |
|
|
128
|
+
| `agents-md` | `AGENTS.md` | Yes | Codex, Windsurf, Copilot |
|
|
129
|
+
| `claude-md` | `CLAUDE.md` | No | Claude Code, Copilot |
|
|
130
|
+
| `cursor-rules` | `.cursor/rules/*.mdc` | No | Cursor |
|
|
131
|
+
| `gemini-md` | `GEMINI.md` | No | Google Gemini CLI |
|
|
132
|
+
| `windsurf-rules` | `.windsurf/rules/*.md` | No | Codeium Windsurf |
|
|
133
|
+
| `clinerules` | `.clinerules/*.md` | No | Cline |
|
|
134
|
+
| `copilot-instructions` | `.github/copilot-instructions.md` | No | Copilot (Global) |
|
|
135
|
+
| `copilot-instructions-scoped` | `.github/instructions/*.md` | No | Copilot (Scoped Context) |
|
|
136
|
+
| `junie-guidelines` | `.junie/guidelines.md` | No | JetBrains Junie |
|
|
137
|
+
|
|
138
|
+
When outputting directory rules like `cursor-rules` or `clinerules`, `agent-policy` generates one default layout and optionally one file per customized role, intelligently assigning frontmatter globs and path references directly into the generated configurations to cleanly silo AI behaviors scope-to-scope!
|
|
139
|
+
|
|
140
|
+
## CI integration
|
|
141
|
+
|
|
142
|
+
Add to your CI workflow to enforce that generated files are never edited by hand:
|
|
143
|
+
|
|
144
|
+
```yaml
|
|
145
|
+
- name: Check agent policy
|
|
146
|
+
run: agent-policy check
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
This step exits non-zero if any generated file is stale or missing, and prints a unified diff to stderr.
|
|
150
|
+
|
|
151
|
+
## Non-goals
|
|
152
|
+
|
|
153
|
+
- Not a replacement for `AGENTS.md` — it _generates_ `AGENTS.md`
|
|
154
|
+
- Not a full enforcement engine or policy-as-code runtime
|
|
155
|
+
- Not a SaaS platform or hosted service
|
|
156
|
+
- Not a daemon or background process
|
|
157
|
+
|
|
158
|
+
## License
|
|
159
|
+
|
|
160
|
+
Apache-2.0
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
agent_policy_cli-0.7.0.data/scripts/agent-policy.exe,sha256=onCgLCsV5S3W58O2DlUthigJONTV6fxbq56GmWsZJLw,13292032
|
|
2
|
+
agent_policy_cli-0.7.0.dist-info/WHEEL,sha256=DFNNXDxEPRy9pnnSBhCwWBjhPjatkUMMZVGeSYsbJW0,103
|
|
3
|
+
agent_policy_cli-0.7.0.dist-info/METADATA,sha256=9r_DXXoaMWuPxAIoYrTeMAOH4iMDFDxlJ64wKfbRoLY,7239
|
|
4
|
+
agent_policy_cli-0.7.0.dist-info/RECORD,,
|