Skip to content

docs(installation): document the 'py' (Python) script type #3640

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mnriem merged 2 commits into from
Jul 22, 2026
+4 −2
Merged

docs(installation): document the 'py' (Python) script type #3640

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
73312ca
docs(installation): document the 'py' (Python) script type
jawwad-ali Jul 22, 2026
7e6ca7c
docs(installation): frame Python as a first-class third script type
jawwad-ali Jul 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ specify init <project_name> --integration pi
specify init <project_name> --integration omp
```

### Specify Script Type (Shell vs PowerShell)
### Specify Script Type (Shell, PowerShell, or Python)

All automation scripts now have both Bash (`.sh`) and PowerShell (`.ps1`) variants.
Automation scripts are available as Bash (`.sh`), PowerShell (`.ps1`), and Python (`.py`) variants.

Auto behavior:

Expand All @@ -92,6 +92,7 @@ Force a specific script type:
```bash
specify init <project_name> --script sh
specify init <project_name> --script ps
specify init <project_name> --script py
Comment thread
jawwad-ali marked this conversation as resolved.
```

### Ignore Agent Tools Check
Expand Down Expand Up @@ -131,6 +132,7 @@ Scripts are installed into a variant subdirectory matching the chosen script typ

- `.specify/scripts/bash/` — contains `.sh` scripts (default on Linux/macOS)
- `.specify/scripts/powershell/` — contains `.ps1` scripts (default on Windows)
- `.specify/scripts/python/` — contains `.py` scripts (chosen with `--script py`; also installs the platform shell fallback)

## Troubleshooting

Expand Down