Skip to content

Commit 157e42c

Browse files
committed
installation docs
1 parent c840a8f commit 157e42c

File tree

3 files changed

+40
-18
lines changed

3 files changed

+40
-18
lines changed

agentstack/telemetry.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ def collect_machine_telemetry(command: str):
7676

7777

7878
def track_cli_command(command: str, args: Optional[str] = None):
79-
if bool(os.environ['AGENTSTATCK_IS_TEST_ENV']):
79+
if bool(os.getenv('AGENTSTACK_IS_TEST_ENV')):
8080
return
8181

8282
try:
@@ -91,7 +91,7 @@ def track_cli_command(command: str, args: Optional[str] = None):
9191
pass
9292

9393
def update_telemetry(id: int, result: int, message: Optional[str] = None):
94-
if bool(os.environ['AGENTSTATCK_IS_TEST_ENV']):
94+
if bool(os.getenv('AGENTSTACK_IS_TEST_ENV')):
9595
return
9696

9797
try:

docs/installation.mdx

Lines changed: 37 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,50 @@ description: 'Installing AgentStack is super easy!'
44
icon: 'cloud-arrow-down'
55
---
66

7-
Use your favorite package manager
8-
9-
<CodeGroup>
7+
## Installing with Brew
8+
```bash
9+
brew tap agentops-ai/tap
10+
brew install agentstack
11+
```
1012

11-
```bash PIP
12-
pip install agentstack
13+
## Installing with pipx
14+
```bash
15+
pipx install agentstack
1316
```
14-
```bash brew
15-
brew tap agentstack-ai/tap
16-
brew install agentstack
17+
18+
## Installing with UV
19+
20+
<Steps>
21+
<Step title="Install UV with their bash install script">
22+
```bash
23+
curl -LsSf https://astral.sh/uv/install.sh | sh
1724
```
18-
```bash uv
19-
uv install agentstack
25+
</Step>
26+
<Step title="Create a virtual environment">
27+
```bash
28+
uv venv
2029
```
21-
</CodeGroup>
30+
</Step>
31+
<Step title="Install AgentStack">
32+
```bash
33+
uv pip install agentstack
34+
```
35+
</Step>
36+
</Steps>
2237

23-
<Note>
24-
Conda is not supported at this time. AgentStack uses Poetry in your project which [does not play well with Conda](https://github.com/AgentOps-AI/AgentStack/issues/40).
25-
</Note>
2638

2739
## After installing
2840

2941
Run `agentstack --version` to verify that the CLI is installed and accessible.
3042

31-
**Congrats! You now have AgentStack installed in your environment**
43+
**Congrats! You now have AgentStack installed in your environment**
44+
45+
<CardGroup cols={1}>
46+
<Card
47+
title="Quickstart"
48+
icon="circle-play"
49+
href="/quickstart"
50+
>
51+
A quickstart guide to using the CLI
52+
</Card>
53+
</CardGroup>

tox.ini

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ commands =
1818
coverage xml
1919
mypy: mypy agentstack
2020
setenv =
21-
AGENTSTATCK_IS_TEST_ENV = 1
21+
AGENTSTACK_IS_TEST_ENV = 1
2222
AGENTSTACK_TELEMETRY_OPT_OUT = 1
2323
AGENTSTACK_UPDATE_DISABLE = 1
2424

0 commit comments

Comments
 (0)