1- # Augment SDK Examples
1+ # Augment Python SDK Examples
22
33This directory contains examples demonstrating how to use the Augment Python SDK.
44
5+ ## Quick Links
6+
7+ - ** [ User Examples] ( user_examples/ ) ** - Numbered tutorial examples (01-09) with a comprehensive [ user guide] ( user_examples/user_guide.md )
8+ - ** [ Documentation] ( docs/ ) ** - Detailed guides on specific features
9+ - ** Basic Examples** - See below for standalone example scripts
10+
11+ ## Installation
12+
13+ ``` bash
14+ pip install auggie-sdk
15+ ```
16+
17+ Make sure you have the Auggie CLI installed:
18+ ``` bash
19+ auggie --version
20+ ```
21+
522## Basic Examples
623
724### ` basic_usage.py `
@@ -16,7 +33,7 @@ Demonstrates fundamental SDK features:
1633
1734** Run it:**
1835``` bash
19- python examples/ basic_usage.py
36+ python basic_usage.py
2037```
2138
2239### ` session_usage.py `
@@ -28,16 +45,15 @@ Shows how to use sessions for conversation continuity:
2845
2946** Run it:**
3047``` bash
31- python examples/ session_usage.py
48+ python session_usage.py
3249```
3350
34- ### ` list_prs.py ` / ` list_prs_2.py `
35- Examples of working with GitHub PRs using the SDK.
51+ ### ` list_prs.py `
52+ Example of working with GitHub PRs using the SDK.
3653
37- ** Run them :**
54+ ** Run it :**
3855``` bash
39- python examples/list_prs.py
40- python examples/list_prs_2.py
56+ python list_prs.py
4157```
4258
4359## ACP Client Examples
@@ -51,33 +67,13 @@ Demonstrates the AuggieACPClient for persistent sessions with the Augment CLI:
5167
5268** Run it:**
5369``` bash
54- python examples/acp_example_usage.py
55- ```
56-
57- ### Claude Code Client Tests
58-
59- For ClaudeCodeACPClient examples and testing, see the ** real E2E tests** :
60-
61- ** Location:** ` tests/test_claude_code_client_e2e.py `
62-
63- ** Prerequisites:**
64- ``` bash
65- npm install -g @zed-industries/claude-code-acp
66- export ANTHROPIC_API_KEY=...
70+ python acp_example_usage.py
6771```
6872
69- ** Run tests:**
70- ``` bash
71- # Quick tests (~30 seconds)
72- pytest tests/test_claude_code_client_e2e.py
73+ ### Claude Code Client
7374
74- # All tests including slow ones (~5-10 minutes)
75- pytest tests/test_claude_code_client_e2e.py -m " "
76- ```
77-
78- ** Documentation:**
79- - [ Claude Code Client Guide] ( ../docs/CLAUDE_CODE_CLIENT.md )
80- - [ Testing Guide] ( ../tests/README_CLAUDE_CODE_TESTS.md )
75+ For ClaudeCodeACPClient documentation, see:
76+ - [ Claude Code Client Guide] ( docs/CLAUDE_CODE_CLIENT.md )
8177
8278## Prompt-to-SDK Conversion
8379
@@ -104,22 +100,7 @@ Finally:
104100- Create fix suggestions for top 3
105101```
106102
107- ** Convert it to SDK code:**
108- ``` bash
109- # In TUI mode
110- /prompt-to-sdk examples/example_complex_prompt.txt
111-
112- # From command line
113- auggie command prompt-to-sdk examples/example_complex_prompt.txt
114- ```
115-
116- ### ` demo_prompt_to_sdk.sh `
117- Interactive demo script that shows the prompt-to-sdk conversion process.
118-
119- ** Run it:**
120- ``` bash
121- ./examples/demo_prompt_to_sdk.sh
122- ```
103+ See [ README_PROMPT_TO_CODE.md] ( README_PROMPT_TO_CODE.md ) for more details on prompt-to-code conversion.
123104
124105## Workflow Patterns
125106
@@ -252,28 +233,35 @@ All examples can be run directly:
252233
253234``` bash
254235# Run a specific example
255- python examples/ basic_usage.py
236+ python basic_usage.py
256237
257238# Run with custom workspace
258- python examples/ basic_usage.py --workspace /path/to/workspace
239+ python basic_usage.py --workspace /path/to/workspace
259240
260241# Run with different model
261- python examples/ basic_usage.py --model gpt-4o
242+ python basic_usage.py --model gpt-4o
262243```
263244
264245## Documentation
265246
266- - ** SDK README** : ` ../README.md `
267- - ** Prompt-to-SDK Guide** : ` ../PROMPT_TO_SDK_GUIDE.md `
268- - ** Slash Command Summary** : ` ../SLASH_COMMAND_SUMMARY.md `
247+ For more comprehensive documentation, see the [ docs] ( docs/ ) directory:
248+ - [ Agent Event Listener] ( docs/AGENT_EVENT_LISTENER.md )
249+ - [ Architecture] ( docs/ARCHITECTURE.md )
250+ - [ Automatic Type Inference] ( docs/AUTOMATIC_TYPE_INFERENCE.md )
251+ - [ Claude Code Client] ( docs/CLAUDE_CODE_CLIENT.md )
252+ - [ Function Calling] ( docs/FUNCTION_CALLING.md )
253+ - [ Prompt to Code] ( docs/PROMPT_TO_CODE.md )
254+ - [ Session Continuity] ( docs/SESSION_CONTINUITY.md )
255+
256+ Also check out the [ user_examples] ( user_examples/ ) directory for more examples and the [ user guide] ( user_examples/user_guide.md ) .
269257
270258## Getting Help
271259
272260If you encounter issues:
273261
274- 1 . Check that the SDK is installed: ` pip install -e . `
262+ 1 . Check that the SDK is installed: ` pip install auggie-sdk `
2752632 . Verify auggie CLI is available: ` auggie --version `
2762643 . Check the workspace path is correct
2772654 . Review error messages for specific issues
278266
279- For more help, see the main SDK documentation .
267+ For more help, see the documentation in the [ docs ] ( docs/ ) directory .
0 commit comments