Getting Started: Guide for Engineers
Guide is a conversational AI agent that understands your organization's engineering framework. It helps you onboard, find growth areas, and interpret engineering artifacts against your skill markers.
Prerequisites
- Node.js 18+
- npm
Install
npm install @forwardimpact/guide
Install and configure
npx fit-codegen --all # provided by @forwardimpact/libcodegen (a dependency of guide)
npx fit-guide init
The fit-codegen step generates gRPC service clients
that Guide needs. Without it, imports fail with a missing module
error.
The init step generates:
-
.env— service secrets (MCP_TOKEN) and port assignments -
config/config.json— service startup configuration
Configure credentials
Guide runs on the Anthropic API. Authenticate using one of:
npx fit-guide login # OAuth PKCE flow (recommended)
Or set ANTHROPIC_API_KEY in .env manually.
Guide validates credentials on startup and reports if they are
missing.
Process data
Before starting the services, process the framework data into the indexes that Guide's services read at runtime:
npx fit-process-resources # provided by @forwardimpact/libresource
npx fit-process-graphs # provided by @forwardimpact/libgraph
These steps transform your data/pathway/ into the
resource index, knowledge store, and graph index. Re-run them
whenever you update framework data.
Start the service stack
npx fit-rc start # provided by @forwardimpact/librc
This supervises all required microservices (trace, vector, graph,
llm, memory, tool, agent, web) in dependency order. Configuration
and secrets are read automatically from .env. Stop them
with npx fit-rc stop.
Usage
npx fit-guide # Start interactive conversation
echo "What skills should I focus on for J060?" | npx fit-guide # Pipe a question
Example pipe-mode output:
Level II engineers in your organization focus on three skill areas:
**System Design** — Design components that interact with other teams'
services, make technology choices within your domain, and document
architectural decisions.
**Technical Leadership** — Lead small cross-functional projects, unblock
peers on technical decisions, and mentor junior engineers on best
practices.
**Operational Awareness** — Own reliability for your services, set up
monitoring and alerting, and participate in incident response rotations.
Based on your current profile, prioritize System Design and Technical
Leadership to close the gap to Level II.
Guide reasons about your organization's specific skill definitions, behaviour expectations, and markers — not generic career advice.
Troubleshooting
Configuration errors on startup
Guide validates configuration before connecting. If you see errors
about missing ANTHROPIC_API_KEY or
MCP_TOKEN, check that:
-
You ran
npx fit-guide init(creates.envwithMCP_TOKEN) -
You ran
npx fit-guide loginor setANTHROPIC_API_KEYin.env
Not authenticated error
Run npx fit-guide login to authenticate with Anthropic,
or set ANTHROPIC_API_KEY in .env.
Data not found
If Guide cannot answer questions, the knowledge indexes may not be populated. Run the processing pipeline:
npx fit-process-resources
npx fit-process-graphs
Then restart the services.
MCP endpoint unreachable
Verify the MCP service is running. Check
npx fit-guide status for health information, then
restart the services:
npx fit-rc stop && npx fit-rc start
Missing module errors after install
Run code generation first — Guide depends on generated gRPC clients:
npx fit-codegen --all
Service startup failures
Check service logs for the failing service:
ls data/logs/ # List available service log directories
cat data/logs/llm/current # View the LLM service log (example)
Each microservice writes to
data/logs/{service}/current. Common causes are missing
environment variables or port conflicts.
Next steps
- Guide product page — feature overview and surface options
- Finding your bearing — Guide usage and configuration
- CLI reference — full command documentation for all tools