Guides
Task-oriented how-to pages that walk you through specific GospeLib workflows step by step. Each guide answers a concrete "How do I...?" question.
Task Guides
| Guide | Description |
|---|---|
| Adding a Service | Scaffold a new Go or Python microservice and wire it into the monorepo |
| Adding a Package | Create a shared TypeScript package under packages/ |
| Adding Corpus Data | Add a new book or schema family to the corpus |
| Web Interfaces | Every browser-accessible GUI in the local dev stack |
CLI Tooling
Guides for the unified gl command -- GospeLib's developer CLI.
| Guide | Description |
|---|---|
| CLI Overview | Architecture, command taxonomy, and installation |
| Visual Design Language | Colors, typography, progress indicators, and layout |
| Help System & Commands | Help formatting, flags, exit codes, and patterns |
| Output & Logging | Output formats, filtering, verbosity, and structlog |
| Configuration & Errors | Config hierarchy, error handling, and did-you-mean |
| Code Organization | Package layout, library standards, and uv usage |
| Migration Plan | Migrating existing tools to gl + terminal mockups |
Data Tools
| Guide | Description |
|---|---|
| FalkorDB Browser | Launch, connect, and explore the knowledge graph |
Related Sections
Looking for something else? These sections cover topics that used to live here:
- Contributing -- code quality, testing, error handling, logging, and other development practices
- Operations -- deployment, monitoring, rollback, and environment management
- Frontend -- Next.js App Router, Expo mobile, and the shared UI library
- Ingest Service -- corpus data model, running the pipeline, and ingest internals