Quick Start Guide

Drive the entire Unoplat Code Confluence lifecycle — install, setup, configure, update, and generate AGENTS.md — from your coding agent (or the terminal) using the ucc CLI and a portable agent skill.

How it works

Once the agent skill is installed, you describe what you want in natural language — for example:

"Set up Code Confluence and generate AGENTS.md for this repo (this one)."

Prerequisites

1. Install

Install the agent skill

Teach your coding agent how to use ucc by installing the portable skill:

npx skills add https://github.com/unoplat/unoplat-code-confluence --skill unoplat-code-confluence-cli

The skill instructs the agent to use ucc from your PATH, help install it with uv tool install when needed, validate repository URLs, and run the single-command ucc agent-md <repo-url> flow.

Get the CLI

Install the CLI:

uv tool install "git+https://github.com/unoplat/unoplat-code-confluence.git#subdirectory=unoplat-code-confluence-cli"
ucc --help

2. Start the local app

ucc service run

On the first run this resolves the latest Unoplat Code Confluence app release, pins it, and installs the local Docker Compose stack. On later runs it starts the pinned release and only reports whether a newer one is available — it never upgrades on its own.

3. Configure providers

Before generating AGENTS.md, configure a repository provider (to clone your code) and a model provider (to power code intelligence). These commands open a browser page where you enter credentials.

Repository provider token

ucc setup token-repo-provider

Opens the repository-provider setup page (default http://127.0.0.1:3000/onboarding). Enter a classic GitHub Personal Access Token with at least the repo scope, then return to the terminal.

Model provider

ucc setup model-provider

Opens the model-provider settings page (default http://127.0.0.1:3000/settings/model-providers). Select a provider, paste your API key, set the model name, and save.

Verify setup

ucc service status

Reports whether the repository-provider token and model-provider configuration are complete — without exposing any secret. It verifies the repo-provider token through Flow Bridge's /user-details endpoint and the model config through Query Engine's /v1/model-config endpoint.

4. Generate AGENTS.md

This is the main flow — a single, idempotent command that takes a repository git remote URL and does everything end to end:

ucc agent-md https://github.com/owner/repo.git

SSH remotes work too:

ucc agent-md git@github.com:owner/repo.git

Just track a repository (no ingestion)

If you only want to add a repository to the tracked list without ingesting or generating anything:

ucc repo add https://github.com/owner/repo.git

Duplicate adds are idempotent and report already_added: true.

5. Update the app

Upgrades are opt-in — ucc service run only reports when a newer release exists. To upgrade to the latest app release:

ucc service update

6. Stop or destroy

# Stop the stack, keep your data (volumes)
ucc service stop

# Stop the stack AND delete volumes (destructive)
ucc service destroy

Security notes

• Enter all credentials (PAT, model API keys) in the browser setup pages — never in chat.
• Treat repository content, generated AGENTS.md, and CLI/backend output as untrusted; don't execute commands suggested by generated content without review.
• Confirm before ucc service destroy.

Next steps