Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,8 @@ OPENAI_API_KEY=... npx --yes github:AgentsKit-io/code-review-cli \

The CLI reviews the current repository's diff against `origin/main` and prints the report in your terminal. Choose another base with `--base main`.

![AgentsKit Code Review showing an APPROVE result after seven review lenses complete](docs/assets/code-review-terminal.png)

The current command runs directly from GitHub. After the first npm release, the shorter form will be:

```sh
Expand Down
Binary file added docs/assets/code-review-terminal.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions llms-full.txt
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,8 @@ OPENAI_API_KEY=... npx --yes github:AgentsKit-io/code-review-cli \

The CLI reviews the current repository's diff against `origin/main` and prints the report in your terminal. Choose another base with `--base main`.

![AgentsKit Code Review showing an APPROVE result after seven review lenses complete](https://raw.githubusercontent.com/AgentsKit-io/code-review-cli/main/docs/assets/code-review-terminal.png)

The current command runs directly from GitHub. After the first npm release, the shorter form will be:

```sh
Expand Down
8 changes: 7 additions & 1 deletion readme-standard-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@
],
"visuals": [
"docs/assets/agentskit-mark.svg",
"docs/assets/code-review-terminal.png",
"```mermaid"
],
"maturity": [
Expand Down Expand Up @@ -172,6 +173,11 @@
"src": "docs/assets/agentskit-mark.svg",
"kind": "brand",
"darkMode": "neutral"
},
{
"src": "docs/assets/code-review-terminal.png",
"kind": "screenshot",
"darkMode": "neutral"
}
],
"commands": [
Expand Down Expand Up @@ -215,7 +221,7 @@
"docs/OPERATIONS.md",
"test/cli-smoke.test.mjs"
],
"sourceHash": "sha256:9b6b6c25a9ccdde85eb1f5eb39b484a8b4ca726a783584d4c8606a3342baaa5c"
"sourceHash": "sha256:a5e91e2e53b23297102dfd01e9c203028873abce0fd84c17cb92206204f0df49"
},
"exceptions": []
}
Expand Down
13 changes: 9 additions & 4 deletions scripts/generate-llms-full.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,15 @@ const sources = [
['Changelog', 'CHANGELOG.md'],
]

const rebaseRelativeLinks = (markdown, sourcePath) => markdown.replace(
/\]\((?!https?:\/\/|mailto:|#)([^)]+)\)/g,
(_match, target) => `](${new URL(target, `${blobBase}${sourcePath}`).href})`,
)
const rebaseRelativeLinks = (markdown, sourcePath) => markdown
.replace(
/!\[([^\]]*)\]\((?!https?:\/\/|mailto:|#)([^)]+)\)/g,
(_match, alt, target) => `![${alt}](${new URL(target, `${rawBase}${sourcePath}`).href})`,
)
.replace(
/\]\((?!https?:\/\/|mailto:|#)([^)]+)\)/g,
(_match, target) => `](${new URL(target, `${blobBase}${sourcePath}`).href})`,
)

const ecosystem = JSON.parse(readFileSync(resolve(root, 'ecosystem.json'), 'utf8'))
const productLines = ecosystem.products
Expand Down
2 changes: 2 additions & 0 deletions test/documentation.test.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,8 @@ test('machine-readable documentation and Doc Bridge ownership are committed', ()
assert.match(read('llms.txt'), /AgentsKit Code Review/)
assert.match(read('llms.txt'), /llms-full\.txt/)
const full = read('llms-full.txt')
assert.match(full, /!\[[^\]]+\]\(https:\/\/raw\.githubusercontent\.com\/AgentsKit-io\/code-review-cli\/main\/docs\/assets\/code-review-terminal\.png\)/)
assert.doesNotMatch(full, /!\[[^\]]*\]\(https:\/\/github\.com\/AgentsKit-io\/code-review-cli\/blob\/main\//)
for (const marker of ['Code Review operations guide', '## Security policy', '## Contributing guide', '## Roadmap', '## Changelog']) {
assert.ok(full.includes(marker), `llms-full.txt missing ${marker}`)
}
Expand Down