feat: implement project launch script run.sh and update README
This commit is contained in:
28
specs/003-project-launch-script/contracts/cli.md
Normal file
28
specs/003-project-launch-script/contracts/cli.md
Normal file
@@ -0,0 +1,28 @@
|
||||
# CLI Contract: Project Launch Script
|
||||
|
||||
## Command
|
||||
|
||||
`./run.sh [options]`
|
||||
|
||||
## Arguments
|
||||
|
||||
| Argument | Description | Default |
|
||||
|----------|-------------|---------|
|
||||
| `--help` | Show help message | N/A |
|
||||
| `--skip-install` | Skip dependency checks and installation | false |
|
||||
|
||||
## Environment Variables
|
||||
|
||||
| Variable | Description | Default |
|
||||
|----------|-------------|---------|
|
||||
| `BACKEND_PORT` | Port for the backend server | 8000 |
|
||||
| `FRONTEND_PORT` | Port for the frontend server | 5173 |
|
||||
|
||||
## Exit Codes
|
||||
|
||||
| Code | Meaning |
|
||||
|------|---------|
|
||||
| 0 | Success (on graceful shutdown) |
|
||||
| 1 | Missing dependencies (python/npm) |
|
||||
| 2 | Installation failure |
|
||||
| 130 | Terminated by SIGINT (Ctrl+C) |
|
||||
Reference in New Issue
Block a user