Skip to content

Commit 15917c2

Browse files
committed
Update local-development.md
1 parent f89361c commit 15917c2

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

docs/local-development.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,44 +62,54 @@ uvx --from git+https://github.com/github/spec-kit.git@your-feature-branch specif
6262
```
6363

6464
## 5. Testing Script Permission Logic
65+
6566
After running an `init`, check that shell scripts are executable on POSIX systems:
67+
6668
```bash
6769
ls -l scripts | grep .sh
6870
# Expect owner execute bit (e.g. -rwxr-xr-x)
6971
```
7072
On Windows this step is a no-op.
7173

7274
## 6. Run Lint / Basic Checks (Add Your Own)
75+
7376
Currently no enforced lint config is bundled, but you can quickly sanity check importability:
7477
```bash
7578
python -c "import specify_cli; print('Import OK')"
7679
```
7780

7881
## 7. Build a Wheel Locally (Optional)
82+
7983
Validate packaging before publishing:
84+
8085
```bash
8186
uv build
8287
ls dist/
8388
```
8489
Install the built artifact into a fresh throwaway environment if needed.
8590

8691
## 8. Using a Temporary Workspace
92+
8793
When testing `init --here` in a dirty directory, create a temp workspace:
94+
8895
```bash
8996
mkdir /tmp/spec-test && cd /tmp/spec-test
9097
python -m src.specify_cli init --here --ai claude --ignore-agent-tools # if repo copied here
9198
```
9299
Or copy only the modified CLI portion if you want a lighter sandbox.
93100

94101
## 9. Debug Network / TLS Skips
102+
95103
If you need to bypass TLS validation while experimenting:
104+
96105
```bash
97106
specify check --skip-tls
98107
specify init demo --skip-tls --ai gemini --ignore-agent-tools
99108
```
100109
(Use only for local experimentation.)
101110

102111
## 10. Rapid Edit Loop Summary
112+
103113
| Action | Command |
104114
|--------|---------|
105115
| Run CLI directly | `python -m src.specify_cli --help` |
@@ -109,12 +119,14 @@ specify init demo --skip-tls --ai gemini --ignore-agent-tools
109119
| Build wheel | `uv build` |
110120

111121
## 11. Cleaning Up
122+
112123
Remove build artifacts / virtual env quickly:
113124
```bash
114125
rm -rf .venv dist build *.egg-info
115126
```
116127

117128
## 12. Common Issues
129+
118130
| Symptom | Fix |
119131
|---------|-----|
120132
| `ModuleNotFoundError: typer` | Run `uv pip install -e .` |
@@ -123,9 +135,8 @@ rm -rf .venv dist build *.egg-info
123135
| TLS errors on corporate network | Try `--skip-tls` (not for production) |
124136

125137
## 13. Next Steps
138+
126139
- Update docs and run through Quick Start using your modified CLI
127140
- Open a PR when satisfied
128141
- (Optional) Tag a release once changes land in `main`
129142

130-
---
131-
Feel free to expand this guide with additional local workflows (debugging, profiling, test automation) as the project matures.

0 commit comments

Comments
 (0)