Skip to content

Commit e709e87

Browse files
authored
docs: Update getting-started with Let's Encrypt-style one-command setup (#18)
* docs: update getting-started and identity with Let's Encrypt-style setup - Rewrite getting-started with 'One Command Setup' as primary path - Add tabbed examples for CLI, Python SDK, and env vars - Document two setup paths: Quick Start vs UI-First - Add SDK quick reference section - Update identity docs with new capiscio init workflow - Consistent 'Just like Let's Encrypt' marketing message * fix: correct CLI reference link path Change reference from cli.md to cli/index.md to match actual file structure
1 parent 6f03ead commit e709e87

2 files changed

Lines changed: 254 additions & 115 deletions

File tree

docs/getting-started/index.md

Lines changed: 153 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Get your agent identity, trust badge, and validation in minutes. Ze
55

66
# Getting Started
77

8-
Get up and running with CapiscIO in minutes. Choose your path based on what you want to accomplish.
8+
Get up and running with CapiscIO in minutes. **One command** gives your AI agent a cryptographic identity, just like Let's Encrypt did for HTTPS.
99

1010
---
1111

@@ -17,21 +17,108 @@ npm install -g capiscio # or: pip install capiscio
1717

1818
---
1919

20-
## Choose Your Path
20+
## The Fastest Path: One Command Setup
21+
22+
Get a complete agent identity in **under 60 seconds**:
23+
24+
=== "CLI"
25+
26+
```bash
27+
# Set your API key (get one free at app.capisc.io)
28+
export CAPISCIO_API_KEY=sk_live_...
29+
30+
# That's it! One command does everything:
31+
capiscio init
32+
```
33+
34+
=== "Python"
35+
36+
```python
37+
from capiscio_sdk import CapiscIO
38+
39+
# One line - handles everything automatically
40+
agent = CapiscIO.connect(api_key="sk_live_...")
41+
42+
print(agent.did) # did:key:z6Mk...
43+
print(agent.badge) # Your trust badge
44+
```
45+
46+
=== "Environment Variables"
47+
48+
```python
49+
# Set CAPISCIO_API_KEY in your environment
50+
agent = CapiscIO.from_env()
51+
```
52+
53+
**What happens automatically:**
54+
55+
1. ✅ Ed25519 key pair generated
56+
2.`did:key` identity derived (RFC-002 compliant)
57+
3. ✅ DID registered with CapiscIO registry
58+
4. ✅ Agent card created with `x-capiscio` extension
59+
5. ✅ Trust badge requested and stored
60+
61+
---
62+
63+
## Choose Your Setup Path
2164

2265
<div class="grid cards" markdown>
2366

24-
- :material-identifier:{ .lg .middle } **Get Agent Identity**
67+
- :material-rocket-launch:{ .lg .middle } **Path 1: Quick Start (Recommended)**
2568

2669
---
2770

28-
Generate a DID for your agent in 60 seconds.
71+
Just use your API key. We auto-discover your agent.
2972

3073
```bash
31-
capiscio key gen
74+
export CAPISCIO_API_KEY=sk_live_...
75+
capiscio init
3276
```
3377

34-
[:octicons-arrow-right-24: Identity Guide](../identity/index.md)
78+
**Best for:** Getting started fast, single-agent setups, demos.
79+
80+
- :material-view-dashboard:{ .lg .middle } **Path 2: UI-First**
81+
82+
---
83+
84+
Create your agent in the dashboard first, then initialize.
85+
86+
```bash
87+
# 1. Create agent at app.capisc.io → get agent ID
88+
# 2. Initialize with specific agent
89+
capiscio init --agent-id agt_abc123
90+
```
91+
92+
**Best for:** Teams, production, multiple agents per org.
93+
94+
</div>
95+
96+
---
97+
98+
## What You Get
99+
100+
After running `capiscio init`, your `.capiscio/` directory contains:
101+
102+
```
103+
.capiscio/
104+
├── private.jwk # Ed25519 private key (keep secret!)
105+
├── public.jwk # Public key
106+
├── did.txt # Your agent's did:key identifier
107+
└── agent-card.json # A2A-compliant agent card
108+
```
109+
110+
Your agent now has:
111+
112+
- **Cryptographic identity** - A globally unique `did:key` that proves who you are
113+
- **Verifiable credentials** - Sign messages and prove authenticity
114+
- **Trust badge** - Registered with CapiscIO for discovery and verification
115+
- **A2A compliance** - Ready to interact with other A2A agents
116+
117+
---
118+
119+
## Choose Your Next Step
120+
121+
<div class="grid cards" markdown>
35122
36123
- :material-check-decagram:{ .lg .middle } **Validate Your Agent**
37124
@@ -47,7 +134,7 @@ npm install -g capiscio # or: pip install capiscio
47134
48135
---
49136
50-
Add cryptographic identity and request verification.
137+
Add request signing and verification.
51138
52139
**15 minutes** · Intermediate
53140
@@ -87,47 +174,81 @@ npm install -g capiscio # or: pip install capiscio
87174
88175
---
89176
90-
## The Fast Path
177+
## Manual Setup (Advanced)
91178
92-
If you just want to try CapiscIO quickly:
179+
If you need more control, you can still do things step-by-step:
93180
94181
```bash
95-
# 1. Install
96-
npm install -g capiscio
97-
98-
# 2. Create a sample agent card
99-
cat > agent-card.json << 'EOF'
100-
{
101-
"name": "My Test Agent",
102-
"description": "Testing CapiscIO validation",
103-
"url": "https://example.com/agent",
104-
"version": "1.0.0",
105-
"protocolVersion": "0.2.0",
106-
"skills": [{ "id": "test", "name": "Test Skill", "description": "A test skill" }]
107-
}
108-
EOF
109-
110-
# 3. Validate
111-
capiscio validate agent-card.json
112-
113-
# 4. Generate identity
114-
mkdir -p capiscio_keys && cd capiscio_keys && capiscio key gen && cd ..
182+
# Generate keys only (no server registration)
183+
capiscio key gen --out-priv private.jwk --out-pub public.jwk
184+
185+
# Derive DID from existing key
186+
capiscio key did --in public.jwk
115187
```
116188

117-
**Done!** You have a validated agent card and a cryptographic identity.
189+
See the [CLI Reference](../reference/cli/index.md) for all options.
118190

119191
---
120192

121193
## Prerequisites
122194

123195
| Path | Requirements |
124196
|------|--------------|
125-
| CLI (validate, key gen) | Node.js 18+ or Python 3.10+ |
126-
| Python SDK (SimpleGuard) | Python 3.10+, FastAPI or similar |
197+
| CLI (`capiscio init`) | Node.js 18+ or Python 3.10+ |
198+
| Python SDK (`CapiscIO.connect()`) | Python 3.10+ |
127199
| CI/CD | GitHub repository |
128200

129201
---
130202

203+
## SDK Quick Reference
204+
205+
=== "Python"
206+
207+
```python
208+
from capiscio_sdk import CapiscIO
209+
210+
# Connect and get full identity
211+
agent = CapiscIO.connect(api_key="sk_live_...")
212+
213+
# Or from environment
214+
agent = CapiscIO.from_env() # Uses CAPISCIO_API_KEY
215+
216+
# Use the agent
217+
print(agent.did) # did:key:z6Mk...
218+
print(agent.badge) # Current trust badge
219+
print(agent.status()) # Full status dict
220+
221+
# Emit events for observability
222+
agent.emit("task_started", {"task_id": "123"})
223+
```
224+
225+
=== "Node.js / TypeScript"
226+
227+
```typescript
228+
import { CapiscIO } from 'capiscio';
229+
230+
// Connect and get full identity
231+
const agent = await CapiscIO.connect({ apiKey: 'sk_live_...' });
232+
233+
console.log(agent.did); // did:key:z6Mk...
234+
console.log(agent.badge); // Current trust badge
235+
```
236+
237+
=== "CLI"
238+
239+
```bash
240+
# Initialize agent identity
241+
capiscio init --api-key $CAPISCIO_API_KEY
242+
243+
# Or with explicit agent ID
244+
capiscio init --agent-id agt_abc123
245+
246+
# View your identity
247+
cat .capiscio/did.txt
248+
```
249+
250+
---
251+
131252
## What's Next?
132253

133254
After getting started, explore:

0 commit comments

Comments
 (0)