Getting Started
Docs » Getting Started » Welcome to ZQK
Raw .md

Welcome to ZQK

Initialization complete. Up and running in 2 commands:

1. Launch Visual Web Studio

./bin/zqk ui -w

Inspect workstreams, milestones, and the real-time Gantt timeline at http://127.0.0.1:8080.

2. Paired Onboarding & Autonomous Execution

Prompt your paired AI assistant:

"You are paired with the ZQK Knowledge Kernel. Let's do a paired walkthrough to capture my project intent, objectify it into kernel objects with zqk new <kind>, and launch our first autonomous swarm execution."

Or execute shovel-ready work directly from your terminal:

./bin/zqk do

Ambient & Agent Integration (Optional)

  • Agent Seating & Directives: Run ./bin/zqk system agent-onboard to detect and prime editor directives.
  • Model Context Protocol (MCP): Run ./bin/zqk mcp install to register local MCP endpoints.
  • Task Discovery: Run ./bin/zqk workflow whats-next to inspect shovel-ready items.
  • Knowledge Kernel: Kernel data stays under .zqk/. Process YAML goes through the CLI, not a text editor.
  • Onboarding Guide: Full documentation at docs/onboarding/COMMUNITY_FIRST_RUN.md.

For the documentation quick-links index, see docs/getting-started.md.