29 lines
690 B
Markdown
29 lines
690 B
Markdown
# 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) |
|