Merge _configs/ into config/ for single configuration directory. Update all path references. Changes: - Move _configs/* to config/ - Update .gitignore for new patterns - No code references to _configs/ found Impact: -1 root directory (layout_conventions.md compliance)
2.3 KiB
2.3 KiB
Installation QuickStart
One command. Everything installed.
The Command
cd syntaxis
just scripts-install
What It Does
1. Compiles binaries
2. Installs binaries to ~/.cargo/bin/
3. Deploys config templates to ~/.config/core/
4. Creates manifest tracking
5. Done ✅
Use It
# List what's installed
just scripts-status
# Run CLI
workspace --version
# Run TUI
syntaxis-tui
# Run API
syntaxis-api
# Edit config (if needed)
nano ~/.config/core/syntaxis-api.toml
What Gets Deployed
~/.config/core/
├── syntaxis-api.toml # Main config
└── features/
├── auth.toml
├── database.toml
├── cache.toml
├── health.toml
├── metrics.toml
├── multi_tenant.toml
├── rate_limit.toml
├── projects.toml # NEW
├── tasks.toml # NEW
├── phases.toml # NEW
└── audit.toml # NEW
How It Works (Phases)
Phase 1 (Ready Now): Config deployment ✅
Install → Copy configs → Done
Phase 2 (Next): Wrapper scripts
Install → Wrappers find config + setup env → Just works
Phase 3 (Later): Version tracking
Manifest tracks versions + enables rollback
Phase 4 (Final): Complete docs
User guides + troubleshooting
Phase 1: To Implement
Time: 4 hours
Tasks:
- Rename
syntaxis-api-config.template.toml→syntaxis-api-config.template.toml - Create 4 new feature templates (projects, tasks, phases, audit)
- Update
scripts/install-cli.nuto deploy configs - Write installation guide
Then: Binaries install with configs automatically ✅
Phase 2: Wrapper Scripts (WIP Design)
What: Wrappers automatically find + setup config
Result:
$ syntaxis-api
✅ Config found
✅ Environment setup
✅ Server running on 8080
No manual env vars needed.
That's It
- Current: Install script only
- Phase 1: Install script + config deployment
- Phase 2: Install script + config deployment + wrappers
- Phase 3: Track versions + rollback
- Phase 4: Full docs
Start Phase 1 when ready.
Status: Phase 1 ready to implement (~4 hours) When: Whenever convenient Who: Any Rust developer