Skip to content

Commit 243e1f0

Browse files
Docs: Add comprehensive troubleshooting section to installation guide (#169)
1 parent 0828163 commit 243e1f0

File tree

1 file changed

+87
-0
lines changed

1 file changed

+87
-0
lines changed

docs/guide/installation.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,3 +62,90 @@ agent-starter-pack create my-awesome-agent
6262
* **`pipx`:** `pipx uninstall agent-starter-pack`
6363
* **`uv tool`:** `uv tool uninstall agent-starter-pack`
6464
* **`pip`/`uv pip` (in .venv):** `(uv) pip uninstall agent-starter-pack`
65+
66+
## Troubleshooting Common Installation Issues
67+
68+
### Command Not Found After Installation
69+
70+
If you encounter "command not found" errors after installation:
71+
72+
1. **Check your PATH**: Ensure that the Python scripts directory is in your PATH:
73+
```bash
74+
echo $PATH
75+
```
76+
2. **Verify installation location**: Check where the package was installed:
77+
```bash
78+
pip show agent-starter-pack
79+
```
80+
3. **Manual path addition**: If needed, add the scripts directory to your PATH:
81+
```bash
82+
export PATH="$HOME/.local/bin:$PATH"
83+
# For user installations
84+
```
85+
Add this line to your `~/.bashrc` or `~/.zshrc` for persistence.
86+
87+
### Permission Errors During Installation
88+
89+
If you encounter permission errors:
90+
91+
1. **Use user installation mode**:
92+
```bash
93+
pip install --user agent-starter-pack
94+
```
95+
2. **Check directory permissions**:
96+
```bash
97+
ls -la ~/.local/bin
98+
```
99+
3. **Fix permissions if needed**:
100+
```bash
101+
chmod +x ~/.local/bin/agent-starter-pack
102+
```
103+
104+
### Python Version Compatibility Issues
105+
106+
If you encounter Python version errors:
107+
108+
1. **Check your Python version**:
109+
```bash
110+
python --version
111+
```
112+
2. **Install a compatible Python version** if needed (3.10 or newer is required).
113+
3. **Create a virtual environment with the correct Python version**:
114+
```bash
115+
python3.10 -m venv .venv
116+
source .venv/bin/activate
117+
```
118+
119+
### Package Dependency Conflicts
120+
121+
If you encounter dependency conflicts:
122+
123+
1. **Use a clean virtual environment**:
124+
```bash
125+
python -m venv .venv
126+
source .venv/bin/activate
127+
pip install agent-starter-pack
128+
```
129+
2. **Update pip and setuptools**:
130+
```bash
131+
pip install --upgrade pip setuptools
132+
```
133+
3. **Install with verbose output to identify conflicts**:
134+
```bash
135+
pip install -v agent-starter-pack
136+
```
137+
138+
### Installation Verification
139+
140+
To verify your installation is working correctly:
141+
142+
1. **Check the installed version**:
143+
```bash
144+
agent-starter-pack --version
145+
```
146+
2. **Run the help command**:
147+
```bash
148+
agent-starter-pack --help
149+
```
150+
151+
If you continue to experience issues, please [file an issue](https://github.com/GoogleCloudPlatform/agent-starter-pack/issues) with details about your environment and the specific error messages you're encountering.

0 commit comments

Comments
 (0)