commands.md 1.7 KB
Read this when you need the supported setup, build, packaging, or configuration commands.
Commands
Dependencies
| Purpose | Command | Source |
|---|---|---|
| Install PHP dependencies | composer install |
composer.json / composer.lock |
| Install Node dependencies | npm ci |
package-lock.json |
Frontend
| Purpose | Command | Effect |
|---|---|---|
| Development build | npm run buildDev |
Vite development-mode build to assets/app/. |
| Production build | npm run buildProd |
Vite production-mode build to assets/app/. |
| Watch build | npm run watch |
Rebuilds assets/app/ on source changes. |
| Package | npm pack |
Creates an npm package using package.json files. |
Configuration
| Purpose | Command | Constraint |
|---|---|---|
| Generate runtime config | scripts/generate-config-bin.sh |
Reads cfg/config.ini; fails if cfg/config.bin already exists. |
The application bootstrap requires cfg/config.bin. The script uses the project's reversible base64+gzip encoding; do not treat it as cryptographic protection. See configuration/spec.md.
Database
omlink.sql is a MySQL dump for the omlink database. It contains DROP DATABASE, CREATE DATABASE, and sample user data; review it before importing and never run it against a database that must be preserved.
Not Declared
No test, lint, format, development server, migration, deployment, or release command is declared in the tracked manifests. Do not invent one in project documentation; use the repository's established operational process.