Skip to content

Commit a2d379b

Browse files
committed
updated readme and verified passing tests
1 parent 739a4c7 commit a2d379b

1 file changed

Lines changed: 29 additions & 4 deletions

File tree

README.md

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ source .venv/bin/activate
3131
uv pip install -e "/Users/bastiannisnaciovenegasarevalo/uvAsTackCloneT-2/actualCustomRepo/uvAgentStack[dev]"
3232

3333
# Create your project
34-
agentstack init <project_name>
34+
uv run agentstack init <project_name>
3535
```
3636

3737
<p align='center'>
@@ -65,7 +65,7 @@ uv pip install -e "/Users/bastiannisnaciovenegasarevalo/uvAsTackCloneT-2/actualC
6565

6666
3. Create your project:
6767
```sh
68-
agentstack init <project_name>
68+
uv run agentstack init <project_name>
6969
```
7070

7171
It will create a directory with your project name inside the current folder.<br>
@@ -99,7 +99,7 @@ Additionally, pre-built templates are available as a shortcut to building your p
9999
After generating a project, the next step is to build your agent project by creating Agents and Tasks. You can do this quickly with AgentStack:
100100

101101
```bash
102-
agentstack generate agent/task <name>
102+
uv run agentstack generate agent/task <name>
103103
```
104104

105105
Modify the agents and tasks by changing the `agents.yaml` and `tasks.yaml` configuration files in `src/config`
@@ -115,7 +115,7 @@ A list of all tools can be found [on our docs](https://docs.agentstack.sh/tools/
115115
Adding tools is as simple as
116116

117117
```bash
118-
agentstack tools add
118+
uv run agentstack tools add
119119
```
120120

121121
## Running Your Agent
@@ -130,6 +130,31 @@ Runs the agent project in development mode.<br>
130130
131131
> 👀 Support for easy production deployment of agents is coming soon.
132132
133+
## Command Alias Setup
134+
135+
To make working with AgentStack more convenient, you can set up an alias for the `uv run agentstack` command:
136+
137+
### For Bash/Zsh (macOS/Linux)
138+
Add this to your `~/.bashrc`, `~/.zshrc`, or equivalent:
139+
```bash
140+
alias agentstack='uv run agentstack'
141+
```
142+
143+
### For Windows PowerShell
144+
Add this to your PowerShell profile:
145+
```powershell
146+
Set-Alias -Name agentstack -Value "uv run agentstack"
147+
```
148+
149+
After setting up the alias, you can use `agentstack` commands directly:
150+
```bash
151+
agentstack init <project_name>
152+
agentstack run
153+
agentstack generate agent <name>
154+
```
155+
156+
> Note: The alias needs to be set up in each new shell session unless added to your shell's configuration file.
157+
133158
## Philosophy
134159

135160
- **Agents should be easy:** There are so many frameworks out there, but starting from scratch is a pain. Similar to `create-react-app`, AgentStack aims to simplify the "from scratch" process by giving you a simple boilerplate of an agent. It uses popular agent frameworks and LLM providers, but provides a cohesive curated experience on top of them.

0 commit comments

Comments
 (0)