40 lines
1.7 KiB
Markdown
40 lines
1.7 KiB
Markdown
|
# VPN Access Server - Suggested Commands
|
||
|
|
|
||
|
|
## Package Management
|
||
|
|
- **Install dependencies**: `uv install`
|
||
|
|
- **Add dependency**: `uv add package-name`
|
||
|
|
- **Add test dependency**: `uv add --group test package-name`
|
||
|
|
- **Update lockfile**: `uv lock`
|
||
|
|
|
||
|
|
## Running the Application
|
||
|
|
- **Show help**: `uv run vpn-access-server --help`
|
||
|
|
- **Authentication**: `uv run vpn-access-server auth`
|
||
|
|
- **Session management**: `uv run vpn-access-server session`
|
||
|
|
- **Health check**: `uv run vpn-access-server health-check`
|
||
|
|
- **Show status**: `uv run vpn-access-server status`
|
||
|
|
- **Initialize database**: `uv run vpn-access-server init-db`
|
||
|
|
- **Seed test data**: `uv run vpn-access-server seed-data`
|
||
|
|
- **Generate client**: `uv run vpn-access-server gen-client <username>`
|
||
|
|
|
||
|
|
## Testing
|
||
|
|
- **Run all tests**: `uv run pytest tests/`
|
||
|
|
- **Run specific test**: `uv run pytest tests/test_specific.py::TestClass::test_method`
|
||
|
|
- **Run with coverage**: `uv run pytest --cov=access tests/`
|
||
|
|
- **Run specific module tests**: `uv run pytest tests/test_utils.py`
|
||
|
|
|
||
|
|
## Development
|
||
|
|
- **Direct Python execution**: `uv run python main.py`
|
||
|
|
- **Direct module execution**: `uv run python -m access.auth`
|
||
|
|
- **Format code**: Use black if configured (not currently in project)
|
||
|
|
- **Lint code**: Use flake8 if configured (not currently in project)
|
||
|
|
|
||
|
|
## Database Operations
|
||
|
|
- **Setup database**: `uv run vpn-access-server init-db && uv run vpn-access-server seed-data`
|
||
|
|
- **Check database health**: `uv run vpn-access-server health-check`
|
||
|
|
|
||
|
|
## System Commands (Darwin/macOS)
|
||
|
|
- **List files**: `ls -la`
|
||
|
|
- **Change directory**: `cd path`
|
||
|
|
- **Find files**: `find . -name "*.py"`
|
||
|
|
- **Search text**: `grep -r "pattern" .`
|
||
|
|
- **Git operations**: `git status`, `git add .`, `git commit -m "message"`
|