Skip to content

Commit fd46272

Browse files
docs: version 0.44.0 docs and update site data (#1294)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 9ef59ae commit fd46272

455 files changed

Lines changed: 25971 additions & 1 deletion

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

website/docusaurus.config.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ const config = {
8080
sidebarPath: require.resolve('./sidebars.js'),
8181
editUrl: 'https://github.com/agent-sh/agnix/tree/main/website/',
8282
showLastUpdateTime: true,
83-
lastVersion: '0.43.0',
83+
lastVersion: '0.44.0',
8484
...(includedDocVersions ? { onlyIncludeVersions: includedDocVersions } : {}),
8585
versions: {
8686
current: {
Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
title: API Reference
3+
description: "agnix CLI flags, output formats, MCP server tools, and LSP capabilities."
4+
---
5+
6+
# API Reference
7+
8+
## CLI
9+
10+
```bash
11+
agnix [OPTIONS] [PATH]
12+
```
13+
14+
### Options
15+
16+
| Flag | Description |
17+
|------|-------------|
18+
| `[PATH]` | Directory or file to validate (default: `.`) |
19+
| `--target <TOOL>` | Single tool focus (`generic`, `claude-code`, `cursor`, `codex`, `kiro`) |
20+
| `--fix` | Apply HIGH and MEDIUM confidence fixes |
21+
| `--dry-run` | Preview fixes without modifying files |
22+
| `--fix-safe` | Apply only HIGH confidence fixes |
23+
| `--fix-unsafe` | Apply all fixes, including LOW confidence fixes |
24+
| `--show-fixes` | Show proposed fix diffs in text output |
25+
| `--format <FMT>` | Output format: `text` (default), `json`, `sarif` |
26+
| `--strict` | Treat warnings as errors (exit code 1) |
27+
| `--config <PATH>` | Config file path (default: `.agnix.toml`) |
28+
| `--watch`, `-w` | Watch mode - re-validate on file changes |
29+
| `--locale <LOCALE>` | Set output locale, e.g. `en`, `es`, `zh-CN` |
30+
| `--list-locales` | List supported locales and exit |
31+
| `--max-files <N>` | Maximum number of files to validate |
32+
| `--verbose`, `-v` | Verbose output |
33+
| `--version` | Print version |
34+
| `--help` | Print help |
35+
36+
### Subcommands
37+
38+
| Command | Description |
39+
|---------|-------------|
40+
| `agnix validate [PATH]` | Validate agent configs explicitly |
41+
| `agnix init` | Initialize a config file |
42+
| `agnix eval <FILE>` | Evaluate rule efficacy against labeled test cases |
43+
| `agnix schema [--output FILE] [--fix]` | Output or regenerate JSON Schema for `.agnix.toml` |
44+
| `agnix tools check` | Check configured tool versions |
45+
| `agnix tools detect` | Detect installed tool versions |
46+
| `agnix telemetry <status\|enable\|disable>` | Manage telemetry settings |
47+
48+
### Output formats
49+
50+
- **text** - Human-readable terminal output with colors
51+
- **json** - Machine-readable JSON object with diagnostics and summary metadata (e.g. version, files_checked, diagnostics, summary, category, rule_severity, applies_to_tool)
52+
- **sarif** - SARIF format for GitHub Code Scanning integration
53+
54+
## MCP server
55+
56+
```bash
57+
cargo install agnix-mcp
58+
agnix-mcp
59+
```
60+
61+
The MCP server exposes these tools:
62+
63+
| Tool | Description |
64+
|------|-------------|
65+
| `validate_file` | Validate a single configuration file |
66+
| `validate_project` | Validate all config files in a project |
67+
| `get_rules` | List all available validation rules |
68+
| `get_rule_docs` | Get documentation for a specific rule |
69+
70+
## LSP server
71+
72+
```bash
73+
cargo install agnix-lsp
74+
agnix-lsp
75+
```
76+
77+
Supported LSP capabilities:
78+
79+
- `textDocument/publishDiagnostics` - real-time validation
80+
- `textDocument/codeAction` - auto-fix suggestions
81+
- `textDocument/hover` - rule documentation on hover
82+
- `workspace/didChangeConfiguration` - runtime config updates
83+
- `workspace/executeCommand` - project-level validation (`agnix.validateProjectRules` command)
84+
85+
## References
86+
87+
- [SPEC.md](https://github.com/agent-sh/agnix/blob/main/SPEC.md) - full technical specification
88+
- [MCP Protocol](https://modelcontextprotocol.io) - MCP specification
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: Configuration
3+
description: "Configure agnix with .agnix.toml - target tools, disable rules, set output format, and more."
4+
---
5+
6+
# Configuration
7+
8+
agnix works with zero configuration. To customize, add `.agnix.toml` to your project root.
9+
10+
## Example
11+
12+
```toml
13+
target = "ClaudeCode"
14+
tools = ["claude-code"]
15+
max_files_to_validate = 10000
16+
locale = "en"
17+
18+
[rules]
19+
disabled_rules = []
20+
```
21+
22+
## Options
23+
24+
| Option | Type | Default | Description |
25+
|--------|------|---------|-------------|
26+
| `target` | string | `Generic` | Legacy single tool focus: `Generic`, `ClaudeCode`, `Cursor`, `Codex`, `Kiro` |
27+
| `tools` | string[] | `[]` | Multi-tool targeting. Overrides `target`. Use values like `claude-code`, `cursor`, `codex`, `kiro`, `github-copilot`, `cline`, `opencode`, `gemini-cli`, `amp`, `roo-code`, `windsurf`, `generic`. |
28+
| `severity` | string | `Warning` | Minimum severity level: `Warning`, `Error`, or `Info` |
29+
| `max_files_to_validate` | int | `10000` | Maximum files to scan |
30+
| `locale` | string | `"en"` | Output locale |
31+
| `[rules].disabled_rules` | string[] | `[]` | Rule IDs to skip (e.g. `["CC-MEM-005"]`) |
32+
| `[rules].disabled_validators` | string[] | `[]` | Validator names to skip |
33+
| `[files]` | table | default excludes | Include or exclude non-standard files |
34+
| `[[overrides]]` | table array | `[]` | Per-file disabled rule overrides |
35+
36+
## CLI flags
37+
38+
CLI flags override `.agnix.toml` values:
39+
40+
```bash
41+
# Target a specific tool
42+
agnix --target cursor .
43+
44+
# Apply fixes
45+
agnix --fix .
46+
47+
# JSON output for CI
48+
agnix --format json .
49+
50+
# SARIF output for GitHub Code Scanning
51+
agnix --format sarif .
52+
53+
# Strict mode
54+
agnix --strict .
55+
```
56+
57+
`--strict`, `--fix`, `--fix-safe`, `--fix-unsafe`, `--dry-run`, `--show-fixes`, and `--format` are CLI flags, not `.agnix.toml` keys.
58+
59+
## Full reference
60+
61+
For the complete configuration specification, see
62+
[docs/CONFIGURATION.md](https://github.com/agent-sh/agnix/blob/main/docs/CONFIGURATION.md)
63+
in the repository.
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
title: Contributing
3+
description: "How to contribute to agnix - report bugs, request rules, improve docs, or write code."
4+
---
5+
6+
# Contributing
7+
8+
Contributions are welcome and appreciated.
9+
10+
## Found something off?
11+
12+
agnix validates against 443 rules, but the agent config ecosystem moves fast. If a rule is wrong, missing, or too noisy, I want to know.
13+
14+
- [Report a bug](https://github.com/agent-sh/agnix/issues/new)
15+
- [Request a rule](https://github.com/agent-sh/agnix/issues/new)
16+
17+
Your real-world configs are the best test suite I could ask for.
18+
19+
## Contribute code
20+
21+
Good first issues are labeled and ready:
22+
[good first issues](https://github.com/agent-sh/agnix/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
23+
24+
Adding a new rule is one of the best ways to get started. Each rule is a self-contained unit with clear inputs, outputs, and test patterns. Find a similar existing rule to use as your template.
25+
26+
## Improve docs
27+
28+
This documentation site is in `website/`. To run locally:
29+
30+
```bash
31+
npm --prefix website ci
32+
npm --prefix website run generate:rules
33+
npm --prefix website start
34+
```
35+
36+
## Where canonical content lives
37+
38+
Long-form source-of-truth docs remain in the repository:
39+
40+
- `README.md`
41+
- `SPEC.md`
42+
- `knowledge-base/`
43+
44+
This website assembles and links that content for navigation and search.
45+
46+
## References
47+
48+
- [CONTRIBUTING.md](https://github.com/agent-sh/agnix/blob/main/CONTRIBUTING.md) - full contribution guidelines
49+
- [SECURITY.md](https://github.com/agent-sh/agnix/blob/main/SECURITY.md) - security policy
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
title: Editor Integration
3+
description: "Set up agnix real-time diagnostics in VS Code, Neovim, JetBrains, and Zed."
4+
---
5+
6+
# Editor Integration
7+
8+
agnix ships an LSP server (`agnix-lsp`) that provides real-time diagnostics, code actions, and hover documentation in your editor.
9+
10+
## Capabilities
11+
12+
- Diagnostics on open, save, and change
13+
- Code actions for fixable findings
14+
- Hover details for rule explanations
15+
16+
## VS Code
17+
18+
Install the extension from the
19+
[VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=avifenesh.agnix).
20+
21+
The extension bundles the LSP server. No additional setup needed.
22+
23+
For manual configuration, see the
24+
[VS Code extension README](https://github.com/agent-sh/agnix/tree/main/editors/vscode).
25+
26+
## JetBrains (IntelliJ, WebStorm, etc.)
27+
28+
Install from the
29+
[JetBrains Plugin Marketplace](https://plugins.jetbrains.com/plugin/30087-agnix).
30+
31+
Configure the `agnix-lsp` binary path in plugin settings if not auto-detected.
32+
33+
For details, see the
34+
[JetBrains plugin README](https://github.com/agent-sh/agnix/tree/main/editors/jetbrains).
35+
36+
## Neovim
37+
38+
Install with lazy.nvim:
39+
40+
```lua
41+
{ "agent-sh/agnix.nvim" }
42+
```
43+
44+
Then in your config:
45+
46+
```lua
47+
require('agnix').setup()
48+
```
49+
50+
The plugin auto-detects and downloads the `agnix-lsp` binary. For full setup instructions, see the
51+
[agnix.nvim README](https://github.com/agent-sh/agnix.nvim).
52+
53+
## Zed
54+
55+
Install the agnix extension from the
56+
[Zed extension marketplace](https://zed.dev/extensions?query=agnix), or see the
57+
[Zed extension README](https://github.com/agent-sh/agnix/tree/main/editors/zed).
58+
59+
## Other editors
60+
61+
Any editor with LSP support can use `agnix-lsp`. Point your LSP client to the binary:
62+
63+
```bash
64+
cargo install agnix-lsp
65+
agnix-lsp
66+
```
67+
68+
For the full editor support matrix, see
69+
[docs/EDITOR-SETUP.md](https://github.com/agent-sh/agnix/blob/main/docs/EDITOR-SETUP.md).
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
title: Getting Started
3+
description: "Install agnix and validate your agent configuration files in under 60 seconds."
4+
---
5+
6+
# Getting Started
7+
8+
:::tip No install needed?
9+
[Try the playground](/playground) - paste your config and see diagnostics instantly, right in your browser.
10+
:::
11+
12+
## 1. Run agnix
13+
14+
No installation needed. Use `npx` to run against your project:
15+
16+
```bash
17+
npx agnix .
18+
```
19+
20+
Expected output:
21+
22+
```
23+
Validating: .
24+
25+
CLAUDE.md:15:1 warning: Generic instruction 'Be helpful and accurate' [fixable]
26+
help: Remove generic instructions. Claude already knows this.
27+
28+
.claude/skills/review/SKILL.md:3:1 error: Invalid name 'Review-Code' [fixable]
29+
help: Use lowercase letters and hyphens only (e.g., 'code-review')
30+
31+
Found 1 error, 1 warning
32+
2 issues are automatically fixable
33+
34+
hint: Run with --fix to apply fixes
35+
```
36+
37+
## 2. Auto-fix issues
38+
39+
```bash
40+
npx agnix --fix .
41+
```
42+
43+
agnix applies safe fixes automatically and reports what changed.
44+
45+
## 3. Install globally (optional)
46+
47+
If you use agnix regularly:
48+
49+
```bash
50+
npm install -g agnix
51+
```
52+
53+
Then run with:
54+
55+
```bash
56+
agnix .
57+
```
58+
59+
See [Installation](./installation.md) for Homebrew, Cargo, and binary options.
60+
61+
## 4. Target a specific tool
62+
63+
Validate only configs relevant to a single tool:
64+
65+
```bash
66+
agnix --target claude-code .
67+
agnix --target cursor .
68+
agnix --target codex .
69+
```
70+
71+
GitHub Copilot validation is enabled by default and can be targeted in config with `tools = ["github-copilot"]`.
72+
73+
## Next steps
74+
75+
- [Configuration](./configuration.md) - customize rules with `.agnix.toml`
76+
- [Rules Reference](./rules/index.md) - browse all 443 rules
77+
- [Editor Integration](./editor-integration.md) - get diagnostics in your editor
78+
- [Troubleshooting](./troubleshooting.md) - common issues and fixes

0 commit comments

Comments
 (0)