Skip to content

Commit 4c87766

Browse files
docs: add Python and Cargo server quickstarts to website
Signed-off-by: Francisco Javier Arceo <farceo@redhat.com>
1 parent 1fc184d commit 4c87766

2 files changed

Lines changed: 53 additions & 13 deletions

File tree

‎website/components/site/quickstart.tsx‎

Lines changed: 42 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ import { useEffect, useState } from 'react';
33
import { Tabs, TabsList, TabsTrigger, TabsContent } from '@/components/ui/tabs';
44
import { Check, Copy, Terminal, Code2, ArrowUpRight } from 'lucide-react';
55
import {
6-
BUILD_COMMAND,
6+
CARGO_COMMAND,
7+
PYTHON_COMMAND,
78
LAUNCH_COMMANDS,
89
getLaunchInstructions,
910
} from '@/lib/quickstart';
@@ -116,10 +117,10 @@ export function Quickstart() {
116117
<li>
117118
<span>02</span>
118119
<div>
119-
<strong>Build Agentic API</strong>
120+
<strong>Install and start Agentic API</strong>
120121
<p>
121-
Install Rust, clone the repository, and build the gateway and
122-
CLI.
122+
Install the Python wheel with pip, or install the Rust CLI
123+
with Cargo. Start the gateway against your vLLM upstream.
123124
</p>
124125
</div>
125126
</li>
@@ -128,8 +129,9 @@ export function Quickstart() {
128129
<div>
129130
<strong>Launch your client</strong>
130131
<p>
131-
Install Codex or Claude Code, then choose your client and
132-
served model.
132+
For the Cargo CLI, choose Codex or Claude Code below. The
133+
client launcher starts its own gateway; use it instead of the
134+
standalone serve command.
133135
</p>
134136
</div>
135137
</li>
@@ -148,7 +150,40 @@ export function Quickstart() {
148150
<span>QUICKSTART</span>
149151
<span>bash</span>
150152
</div>
151-
<CopyCode code={BUILD_COMMAND} label="Build from source" />
153+
<Tabs defaultValue="python" className="launch-tabs">
154+
<TabsList
155+
className="launch-tab-list"
156+
aria-label="Choose installation method"
157+
>
158+
<TabsTrigger value="python">Python / pip</TabsTrigger>
159+
<TabsTrigger value="cargo">Cargo</TabsTrigger>
160+
</TabsList>
161+
<TabsContent value="python">
162+
<CopyCode
163+
code={PYTHON_COMMAND}
164+
label="Install and start with Python"
165+
/>
166+
<div className="terminal-note">
167+
<p>
168+
Python 3.10+. Download your platform wheel from the{' '}
169+
<a href={`${REPO}/actions/workflows/release-python.yml`}>
170+
release workflow
171+
</a>
172+
. PyPI publication is pending; once published, install with{' '}
173+
<code>python -m pip install agentic-api</code>.
174+
</p>
175+
</div>
176+
</TabsContent>
177+
<TabsContent value="cargo">
178+
<CopyCode
179+
code={CARGO_COMMAND}
180+
label="Install and start with Cargo"
181+
/>
182+
</TabsContent>
183+
</Tabs>
184+
<p className="terminal-note">
185+
Coding clients with the Cargo-installed CLI
186+
</p>
152187
<Tabs defaultValue="codex" className="launch-tabs">
153188
<TabsList
154189
className="launch-tab-list"

‎website/lib/quickstart.ts‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
11
import { REPO } from './site';
2-
export const BUILD_COMMAND = `git clone https://github.com/vllm-project/agentic-api.git
3-
cd agentic-api
4-
cargo build -p agentic-server --bins`;
2+
export const BUILD_COMMAND = 'cargo install agentic-server --locked';
3+
export const PYTHON_COMMAND = `python -m venv .venv
4+
source .venv/bin/activate
5+
# Download the wheel for your platform first.
6+
python -m pip install /absolute/path/to/agentic_api-PLATFORM.whl
7+
python -m agentic_api serve --vllm-base-url http://127.0.0.1:5050`;
8+
export const CARGO_COMMAND = `${BUILD_COMMAND}
9+
agentic serve --upstream http://127.0.0.1:5050`;
510
export const LAUNCH_COMMANDS = {
611
codex:
7-
'./target/debug/agentic run codex \\\n --upstream http://127.0.0.1:5050 \\\n --model Qwen/Qwen3-30B-A3B-FP8',
12+
'agentic run codex \\\n --upstream http://127.0.0.1:5050 \\\n --model Qwen/Qwen3-30B-A3B-FP8',
813
claude:
9-
'./target/debug/agentic run claude \\\n --upstream http://127.0.0.1:5050 \\\n --model Qwen/Qwen3-30B-A3B-FP8',
14+
'agentic run claude \\\n --upstream http://127.0.0.1:5050 \\\n --model Qwen/Qwen3-30B-A3B-FP8',
1015
};
1116
export function getLaunchInstructions(input: unknown) {
1217
if (
@@ -20,7 +25,7 @@ export function getLaunchInstructions(input: unknown) {
2025
return {
2126
harness: input.harness,
2227
prerequisites:
23-
'Install Rust and the selected client. Serve a tool-capable model with vLLM at http://127.0.0.1:5050. Replace the example model with the one you serve.',
28+
'Install agentic-server with Cargo and install the selected client. Serve a tool-capable model with vLLM at http://127.0.0.1:5050. Replace the example model with the one you serve.',
2429
build: BUILD_COMMAND,
2530
launch: LAUNCH_COMMANDS[input.harness],
2631
guide: `${REPO}#agentic-api-cli`,

0 commit comments

Comments
 (0)