140 lines
4.4 KiB
Markdown
140 lines
4.4 KiB
Markdown
|
# SYNTAXIS Bundle - Installation & Setup Guide
|
||
|
|
|
||
|
|
> **Systematic Orchestration, Perfectly Arranged**
|
||
|
|
|
||
|
|
This bundle contains **syntaxis** - a production-grade project orchestration platform for developers and teams.
|
||
|
|
|
||
|
|
## 📦 What's Inside
|
||
|
|
|
||
|
|
This self-contained bundle includes everything you need:
|
||
|
|
|
||
|
|
- **3 Binaries**: CLI, Terminal UI, REST API server
|
||
|
|
- **Configuration Files**: Pre-configured for all 3 applications
|
||
|
|
- **Documentation**: Quick start, installation, configuration, and troubleshooting
|
||
|
|
- **Installation Scripts**: Bash and NuShell installers with interactive setup
|
||
|
|
|
||
|
|
## ⚡ Quick Start (2 Minutes)
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# 1. Extract the bundle
|
||
|
|
tar -xzf syntaxis-v*.tar.gz
|
||
|
|
cd syntaxis-v*
|
||
|
|
|
||
|
|
# 2. Install binaries
|
||
|
|
bash install.sh --interactive
|
||
|
|
|
||
|
|
# 3. Configure settings
|
||
|
|
bash setup-config.sh --interactive
|
||
|
|
|
||
|
|
# 4. Start using syntaxis
|
||
|
|
syntaxis-cli --version
|
||
|
|
syntaxis-tui
|
||
|
|
syntaxis-api &
|
||
|
|
```
|
||
|
|
|
||
|
|
## 📚 Documentation
|
||
|
|
|
||
|
|
- **[QUICK_START.md](QUICK_START.md)** — 5-minute guide to get started
|
||
|
|
- **[docs/installation.md](docs/installation.md)** — Detailed installation methods
|
||
|
|
- **[CONFIG.md](CONFIG.md)** — Configuration reference for all applications
|
||
|
|
- **[TROUBLESHOOTING.md](TROUBLESHOOTING.md)** — Common issues and solutions
|
||
|
|
|
||
|
|
## 🛠️ Installation Methods
|
||
|
|
|
||
|
|
### Bash (Recommended)
|
||
|
|
```bash
|
||
|
|
# Step 1: Install binaries with interactive prompts
|
||
|
|
bash install.sh --interactive
|
||
|
|
|
||
|
|
# Step 2: Configure settings
|
||
|
|
bash setup-config.sh --interactive
|
||
|
|
```
|
||
|
|
|
||
|
|
### NuShell Alternative
|
||
|
|
```bash
|
||
|
|
# Step 1: Install using NuShell
|
||
|
|
nu install.nu --prefix ~/.local
|
||
|
|
|
||
|
|
# Step 2: Configure settings
|
||
|
|
bash setup-config.sh --interactive
|
||
|
|
```
|
||
|
|
|
||
|
|
### Manual (Custom Prefix)
|
||
|
|
```bash
|
||
|
|
# Install to custom location
|
||
|
|
bash install.sh --prefix /opt/syntaxis
|
||
|
|
|
||
|
|
# Then configure
|
||
|
|
bash setup-config.sh --interactive
|
||
|
|
```
|
||
|
|
|
||
|
|
## 🎯 What Is SYNTAXIS?
|
||
|
|
|
||
|
|
SYNTAXIS is a production-grade project orchestration platform offering:
|
||
|
|
|
||
|
|
- **Systematic Organization**: Projects with clear phases and task management
|
||
|
|
- **Multiple Interfaces**: CLI for automation, TUI for interactive work, API for integration
|
||
|
|
- **Database Options**: SQLite (default) or SurrealDB for team deployments
|
||
|
|
- **Zero Compromises**: Fully tested, documented, and production-ready
|
||
|
|
|
||
|
|
Perfect for:
|
||
|
|
- Individual developers managing projects
|
||
|
|
- Teams coordinating workflows
|
||
|
|
- Enterprises orchestrating mission-critical systems
|
||
|
|
|
||
|
|
## 🚀 Next Steps
|
||
|
|
|
||
|
|
1. **Install**: Run `bash install.sh --interactive` to install binaries
|
||
|
|
2. **Configure**: Run `bash setup-config.sh --interactive` to set up configuration
|
||
|
|
3. **Learn**: Read [QUICK_START.md](QUICK_START.md) for basic usage
|
||
|
|
4. **Explore**: Try `syntaxis-tui` for interactive experience
|
||
|
|
|
||
|
|
## 📖 Learn More
|
||
|
|
|
||
|
|
- **Official Website**: https://syntaxis.dev
|
||
|
|
- **Documentation**: https://doc.syntaxis.dev
|
||
|
|
- **GitHub Repository**: https://github.com/syntaxis/syntaxis
|
||
|
|
- **Issue Tracker**: https://github.com/syntaxis/syntaxis/issues
|
||
|
|
|
||
|
|
## 📋 System Requirements
|
||
|
|
|
||
|
|
- **Linux**: glibc-based (Ubuntu, Fedora, Debian, etc.)
|
||
|
|
- **macOS**: Intel (x86_64) or Apple Silicon (ARM64)
|
||
|
|
- **Windows**: Windows 10+ with MSVC runtime
|
||
|
|
- **Shell**: bash, zsh, fish, or NuShell
|
||
|
|
|
||
|
|
## ✨ Bundle Contents
|
||
|
|
|
||
|
|
```
|
||
|
|
syntaxis-v0.1.0-<target>/
|
||
|
|
├── install.sh # Bash installer (Step 1: Install binaries)
|
||
|
|
├── install.nu # NuShell installer (alternative to bash)
|
||
|
|
├── setup-config.sh # Configuration helper (Step 2: Configure)
|
||
|
|
├── README.md # This file
|
||
|
|
├── QUICK_START.md # 5-minute getting started
|
||
|
|
├── docs/installation.md # Installation reference
|
||
|
|
├── CONFIG.md # Configuration guide
|
||
|
|
├── TROUBLESHOOTING.md # Common issues
|
||
|
|
├── manifest.toml # Bundle metadata & checksums
|
||
|
|
├── bin/ # Binary executables
|
||
|
|
│ ├── syntaxis-cli # CLI application
|
||
|
|
│ ├── syntaxis-tui # Terminal UI
|
||
|
|
│ └── syntaxis-api # REST API server
|
||
|
|
└── configs/ # Configuration templates
|
||
|
|
├── database-default.toml # SQLite (default)
|
||
|
|
├── database-surrealdb.toml # SurrealDB (optional)
|
||
|
|
├── syntaxis-cli.toml # CLI configuration
|
||
|
|
├── syntaxis-tui.toml # TUI configuration
|
||
|
|
└── syntaxis-api.toml # API configuration
|
||
|
|
```
|
||
|
|
|
||
|
|
## 🤝 Support
|
||
|
|
|
||
|
|
Having issues? Check [TROUBLESHOOTING.md](TROUBLESHOOTING.md) first.
|
||
|
|
|
||
|
|
For bugs or feature requests, visit: https://github.com/syntaxis/syntaxis/issues
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
**SYNTAXIS** v0.1.0 • [syntaxis.dev](https://syntaxis.dev)
|