Skip to content

Commit 220e962

Browse files
committed
Refactor installation documentation for improved readability
- Reformatted code blocks for consistency and clarity. - Specified the command for uninstalling spoon-cli. - Enhanced the structure of the "Next Steps" section for better navigation.
1 parent 7333c02 commit 220e962

File tree

1 file changed

+30
-22
lines changed

1 file changed

+30
-22
lines changed

docs/cli/installation.md

Lines changed: 30 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -117,28 +117,33 @@ This command will show:
117117
### Common Issues
118118

119119
1. **Python Version Too Old**
120-
```bash
121-
python --version
122-
# Should show 3.11 or higher
123-
```
120+
121+
```bash
122+
python --version
123+
# Should show 3.11 or higher
124+
```
124125

125126
2. **Permission Denied**
126-
```bash
127-
# Use user installation
128-
pip install --user
129-
# Or use virtual environment
130-
python -m venv spoon_env
131-
source spoon_env/bin/activate # Linux/macOS
132-
# spoon_env\Scripts\activate # Windows
133-
pip install ```
127+
128+
```bash
129+
# Use user installation
130+
pip install --user
131+
# Or use virtual environment
132+
python -m venv spoon_env
133+
source spoon_env/bin/activate # Linux/macOS
134+
# spoon_env\Scripts\activate # Windows
135+
pip install
136+
```
134137

135138
3. **Dependency Conflicts**
136-
```bash
137-
# Upgrade pip
138-
pip install --upgrade pip
139139

140-
# Install in isolated environment
141-
pip install --isolated ```
140+
```bash
141+
# Upgrade pip
142+
pip install --upgrade pip
143+
144+
# Install in isolated environment
145+
pip install --isolated
146+
```
142147

143148
### Windows-Specific Issues
144149

@@ -153,19 +158,22 @@ On Windows, you might need to:
153158
To upgrade to the latest version:
154159

155160
```bash
156-
pip install --upgrade ```
161+
pip install --upgrade spoon-cli
162+
```
157163

158164
## Uninstalling
159165

160-
To remove :
166+
To remove spoon-cli:
161167

162168
```bash
163-
pip uninstall ```
169+
pip uninstall spoon-cli
170+
```
164171

165172
Note: This will not remove configuration files or chat histories you may have created.
166173

167174
## Next Steps
168175

169176
After installation, proceed to:
170-
- [Configuration Guide](./configuration.md) - Learn how to configure - [Basic Usage](./basic-usage.md) - Start using - [Advanced Features](./advanced-features.md) - Explore advanced capabilities
171-
177+
- [Configuration Guide](./configuration.md) - Learn how to configure
178+
- [Basic Usage](./basic-usage.md) - Start using
179+
- [Advanced Features](./advanced-features.md) - Explore advanced capabilities

0 commit comments

Comments
 (0)