Getting Started

Choose the right Downcity documentation space for the surface you want to use

Getting Started

Downcity has several user surfaces. This page is a map, not a command tutorial.

Use it to decide where to start:

  • Use Downcity CLI when you want to run local agents, manage project agents, or use built-in plugin commands.
  • Use CLI and its fed/downfed commands when you want to create, manage, or deploy a Federation project.
  • Use Agent SDK when you want to embed agent behavior in your own Node.js application.
  • Use City SDK when you want to build services, model providers, billing, usage, or admin surfaces.
  • Use Agent Plugins Docs when you want to understand built-in plugin behavior or author plugin integrations.
  • Use Products Docs when you want product-facing usage for Downcity CLI, Downcity Console, or Chrome Extension.

First understand the model:

  1. How Downcity Fits Together
  2. Agent Overview
  3. Configuration Model

Then choose the practical surface:

What This Space Explains

Downcity docs explain why the system is split into Downcity, City, Agent, plugins, services, permissions, and configuration layers.

Concrete command flags, examples, and step-by-step operation guides live in product or SDK documentation.