Skip to content

Commit f612277

Browse files
committed
docs: refresh readme package coverage
1 parent 4b89a73 commit f612277

1 file changed

Lines changed: 27 additions & 4 deletions

File tree

README.md

Lines changed: 27 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ agenthint --json # print the structured detection result
6767
agenthint --explain # print a short explanation
6868
agenthint doctor # print detection details and setup advice
6969
agenthint doctor --json
70-
# print detection details and setup advice as JSON
70+
# print detection details and setup advice as JSON
7171
agenthint init codex # print the recommended AI_AGENT value
7272
```
7373

@@ -98,6 +98,13 @@ cargo install agenthint
9898
agenthint --json
9999
```
100100

101+
Install from PyPI:
102+
103+
```sh
104+
python3 -m pip install agenthint
105+
agenthint --json
106+
```
107+
101108
Install the latest native binary from GitHub Releases:
102109

103110
```sh
@@ -145,6 +152,18 @@ Run the Rust CLI locally:
145152
cargo run -q -p agenthint -- --json
146153
```
147154

155+
## Python API
156+
157+
```python
158+
from agenthint import detect_agent
159+
160+
result = detect_agent()
161+
162+
if result.is_agent:
163+
# Prefer structured, quiet, non-interactive output.
164+
pass
165+
```
166+
148167
## Detection Model
149168

150169
The result includes:
@@ -161,7 +180,8 @@ Detection priority:
161180
3. explicit `AI_AGENT`
162181
4. known environment signals
163182
5. documented filesystem signals
164-
6. low-confidence stdio hints
183+
6. low-confidence parent process signals
184+
7. low-confidence stdio hints
165185

166186
## Supported Agents
167187

@@ -187,6 +207,7 @@ Current known agent names include:
187207
- Cline
188208
- Roo Code
189209
- Kilo Code
210+
- Mistral Vibe
190211
- v0
191212

192213
Custom agents are supported through any non-empty `AI_AGENT` value.
@@ -219,11 +240,11 @@ Planned:
219240

220241
- standalone native binary releases
221242

222-
The unscoped `agenthint` name currently appears available on npm and crates.io. If the npm name becomes unavailable before first publish, the fallback package name is `@forjd/agenthint`.
243+
The packages use the unscoped `agenthint` name across npm, crates.io, and PyPI. If the npm name becomes unavailable before first publish, the fallback package name is `@forjd/agenthint`.
223244

224245
## CI and Releases
225246

226-
GitHub Actions runs formatting, linting, TypeScript tests, Rust tests, npm package checks, and `cargo publish --dry-run`.
247+
GitHub Actions runs formatting, linting, TypeScript tests, Rust tests, Python tests, npm package checks, and `cargo publish --dry-run`.
227248

228249
Releases use release-please with Conventional Commits. npm publishing is configured for trusted publishing via GitHub Actions OIDC, so no long-lived npm token is required. Before the first npm publish, configure the trusted publisher in npm package settings for `forjd/agenthint` and `.github/workflows/release.yml`.
229250

@@ -250,6 +271,8 @@ Useful commands:
250271
npm run format
251272
npm run lint
252273
npm test
274+
npm run python:test
275+
npm run generate:rules
253276
cargo test --workspace
254277
cargo clippy --workspace --all-targets -- -D warnings
255278
```

0 commit comments

Comments
 (0)