Skip to content

Commit 506637d

Browse files
authored
docs: remove fabricated env var and command (#5)
1 parent 9848473 commit 506637d

3 files changed

Lines changed: 50 additions & 10 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ Once installed, the `capiscio` command is available in your terminal. It passes
2727
# Validate an agent
2828
capiscio validate https://my-agent.example.com
2929

30-
# Check compliance score
31-
capiscio score https://my-agent.example.com
30+
# Validate with JSON output (includes scores)
31+
capiscio validate https://my-agent.example.com --json
3232

3333
# Check version
34-
capiscio --version
34+
capiscio version
3535
```
3636

3737
### Wrapper Utilities

docs/index.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,10 @@ description: Official documentation for the CapiscIO Python CLI wrapper.
55

66
# CapiscIO Python CLI
77

8-
The **CapiscIO Python CLI** is a lightweight wrapper around the CapiscIO Core binary, designed for seamless integration into Python environments.
8+
The **CapiscIO Python CLI** is a lightweight wrapper around the [CapiscIO Core](https://github.com/capiscio/capiscio-core) binary, designed for seamless integration into Python environments.
9+
10+
!!! info "This is a Wrapper Package"
11+
This package does NOT contain validation logic. It downloads and executes the `capiscio-core` Go binary, which performs the actual validation.
912

1013
<div class="grid cards" markdown>
1114

@@ -21,14 +24,32 @@ The **CapiscIO Python CLI** is a lightweight wrapper around the CapiscIO Core bi
2124

2225
---
2326

24-
Command reference and usage.
27+
Wrapper commands and usage.
2528

2629
[:octicons-arrow-right-24: Commands](./reference/commands.md)
2730

2831
</div>
2932

30-
## Installation
33+
## Quick Start
3134

3235
```bash
36+
# Install
3337
pip install capiscio
38+
39+
# Validate an agent card
40+
capiscio validate ./agent-card.json
41+
42+
# Validate with JSON output (includes scores)
43+
capiscio validate ./agent-card.json --json
44+
45+
# Check core binary version
46+
capiscio version
3447
```
48+
49+
## What This Package Does
50+
51+
1. **Downloads** the correct `capiscio-core` binary for your platform (macOS/Linux/Windows, AMD64/ARM64)
52+
2. **Caches** the binary in your user cache directory
53+
3. **Executes** the binary with your arguments, using `os.execv()` for zero overhead
54+
55+
All validation logic lives in `capiscio-core`. This wrapper just makes it easy to install via pip.

docs/reference/commands.md

Lines changed: 23 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,27 @@ $ capiscio --wrapper-clean
2020
Cleaned cache directory: /Users/username/Library/Caches/capiscio/bin
2121
```
2222

23-
## Environment Variables
23+
---
2424

25-
| Variable | Description |
26-
|----------|-------------|
27-
| `CAPISCIO_CORE_PATH` | (Optional) Override the path to the `capiscio-core` binary. If set, the wrapper will use this binary instead of downloading one. |
25+
## Core Commands
26+
27+
All other commands are passed directly to the `capiscio-core` binary. See the [CLI Reference](https://docs.capisc.io/reference/cli/) for full documentation.
28+
29+
### Common Commands
30+
31+
```bash
32+
# Validate an agent card
33+
capiscio validate ./agent-card.json
34+
35+
# Validate with JSON output
36+
capiscio validate ./agent-card.json --json
37+
38+
# Validate with live endpoint testing
39+
capiscio validate https://agent.example.com --test-live
40+
41+
# Check version of the core binary
42+
capiscio version
43+
44+
# Generate a signing key
45+
capiscio key gen --output ./my-key.jwk
46+
```

0 commit comments

Comments
 (0)