9cef9b8d57
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)
195 lines
3.8 KiB
Markdown
195 lines
3.8 KiB
Markdown
# syntaxis Quick Start (5 Minutes)
|
|
|
|
Get up and running with syntaxis in 5 minutes.
|
|
|
|
## Installation (1 minute)
|
|
|
|
```bash
|
|
# Extract bundle
|
|
tar -xzf syntaxis-v0.1.0-*.tar.gz
|
|
cd syntaxis-v0.1.0-*
|
|
|
|
# Install binaries and configure
|
|
./install.sh --prefix ~/.local --interactive
|
|
|
|
# Setup your shell
|
|
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
|
|
source ~/.bashrc
|
|
```
|
|
|
|
## Verify Installation (30 seconds)
|
|
|
|
```bash
|
|
# Check all binaries are installed
|
|
syntaxis-cli --version
|
|
syntaxis-tui --version
|
|
syntaxis-api --version
|
|
|
|
# Check configuration directory
|
|
ls ~/.config/syntaxis/
|
|
```
|
|
|
|
Expected output:
|
|
```
|
|
syntaxis-cli v0.1.0
|
|
syntaxis-tui v0.1.0
|
|
syntaxis-api v0.1.0
|
|
|
|
~/.config/syntaxis/:
|
|
syntaxis-cli.toml
|
|
syntaxis-tui.toml
|
|
syntaxis-api.toml
|
|
database-default.toml
|
|
```
|
|
|
|
## Create Your First Project (2 minutes)
|
|
|
|
### Using CLI
|
|
|
|
```bash
|
|
# Create a new project
|
|
syntaxis-cli project create \
|
|
--name "my-project" \
|
|
--description "My first syntaxis project"
|
|
|
|
# List projects
|
|
syntaxis-cli project list
|
|
|
|
# Show project details
|
|
syntaxis-cli project show my-project
|
|
```
|
|
|
|
### Using TUI (Interactive)
|
|
|
|
```bash
|
|
# Start interactive terminal UI
|
|
syntaxis-tui
|
|
|
|
# Navigation (vim-style):
|
|
# j/k - move down/up
|
|
# h/l - move left/right
|
|
# i - insert mode
|
|
# :w - save
|
|
# :q - quit
|
|
```
|
|
|
|
## Create a Task (1 minute)
|
|
|
|
### CLI Method
|
|
|
|
```bash
|
|
# Create a phase first
|
|
syntaxis-cli phase create \
|
|
--project my-project \
|
|
--name "Development" \
|
|
--description "Development phase"
|
|
|
|
# Create a task
|
|
syntaxis-cli task create \
|
|
--project my-project \
|
|
--phase Development \
|
|
--title "Setup database" \
|
|
--description "Initialize SQLite database"
|
|
|
|
# List tasks
|
|
syntaxis-cli task list --project my-project
|
|
```
|
|
|
|
### TUI Method
|
|
|
|
```bash
|
|
syntaxis-tui
|
|
|
|
# In TUI:
|
|
# 1. Navigate to Projects
|
|
# 2. Select "my-project"
|
|
# 3. Press 'a' to add new item
|
|
# 4. Enter task details
|
|
# 5. Press :w to save
|
|
```
|
|
|
|
## Run the API Server (1 minute)
|
|
|
|
```bash
|
|
# Start API server
|
|
syntaxis-api &
|
|
|
|
# Check if running
|
|
curl http://localhost:3000/health
|
|
|
|
# View API docs
|
|
open http://localhost:3000/docs
|
|
```
|
|
|
|
## Next Steps
|
|
|
|
- **Configuration**: See `CONFIG_GUIDE.md` for detailed settings
|
|
- **Full Installation**: See `BUNDLE_docs/installation.md` for advanced options
|
|
- **Troubleshooting**: See `TROUBLESHOOTING.md` for common issues
|
|
- **Project Docs**: Visit the [syntaxis repository](https://github.com/syntaxis/syntaxis)
|
|
|
|
## Common Commands
|
|
|
|
```bash
|
|
# Project Management
|
|
syntaxis-cli project create --name "project-name"
|
|
syntaxis-cli project list
|
|
syntaxis-cli project show project-name
|
|
syntaxis-cli project delete project-name
|
|
|
|
# Phase Management (project lifecycle)
|
|
syntaxis-cli phase create --project p1 --name "Development"
|
|
syntaxis-cli phase list --project p1
|
|
syntaxis-cli phase update --project p1 --name "Development" --status active
|
|
|
|
# Task Management
|
|
syntaxis-cli task create --project p1 --phase dev --title "Task name"
|
|
syntaxis-cli task list --project p1
|
|
syntaxis-cli task update --project p1 --task-id 1 --status completed
|
|
|
|
# API Server
|
|
syntaxis-api --port 3000
|
|
syntaxis-api --help
|
|
|
|
# Interactive TUI
|
|
syntaxis-tui
|
|
```
|
|
|
|
## Tips
|
|
|
|
- **Save time**: Use TUI (`syntaxis-tui`) for interactive project management
|
|
- **Automation**: Use CLI (`syntaxis-cli`) in scripts and pipelines
|
|
- **API**: Use REST API for web dashboards and integrations
|
|
- **Config**: Edit `~/.config/syntaxis/*.toml` for custom settings
|
|
- **Data**: Projects stored in `~/.local/share/syntaxis/`
|
|
|
|
## Troubleshooting
|
|
|
|
**Command not found**
|
|
```bash
|
|
# Make sure PATH is set
|
|
echo $PATH | grep .local/bin
|
|
|
|
# Re-source shell config
|
|
source ~/.bashrc
|
|
```
|
|
|
|
**Permission denied**
|
|
```bash
|
|
# Make binaries executable
|
|
chmod +x ~/.local/bin/syntaxis-*
|
|
```
|
|
|
|
**Config not found**
|
|
```bash
|
|
# Create config directory
|
|
mkdir -p ~/.config/syntaxis
|
|
./setup-config.sh --interactive
|
|
```
|
|
|
|
See `TROUBLESHOOTING.md` for more help.
|
|
|
|
---
|
|
|
|
You're ready! Start with `syntaxis-tui` for an interactive experience or `syntaxis-cli` for command-line power.
|