Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.joggr.ai/llms.txt

Use this file to discover all available pages before exploring further.

Before running your first workflow, you need Workflows installed in your repo and codebase documentation generated.

​
Prerequisites

  • Joggr CLI installed — run jog --version to confirm. See Install the CLI if needed.
  • Authenticated — run jog auth login if you have not already. See Authentication.
  • AI tool launched at least once — Claude Code or Cursor must have been opened at least once before Workflows can install into it.

​
1. Install Workflows

From your repository root, run: 
jog init
When the menu appears, select Set up Guided Generative Workflows (GG). Then select your AI tool:
  • Claude Code
  • Cursor
Workflows installs into your AI tool and creates a .joggr/.gg/ directory in your repository. When setup completes, commit .joggr/.gg/ to git so your teammates can pull it down.

​
2. Generate Codebase Docs

In Claude Code or Cursor, run: 
/gg-codebase
This scans your repository and generates documentation covering your architecture, conventions, stack, integrations, testing patterns, and development workflow. /gg-codebase reads these docs during research and planning — the better the docs, the better the results. Run this once per repository. Re-run it after major structural changes. See Codebase for details on what gets generated.

​
Keeping Workflows Up to Date

When a new version is available, update the CLI: 
jog update
Then re-run setup: 
jog init
Select Set up Guided Generative Workflows (GG) again. This updates Workflows in your AI tool and repo to the latest version.

​
Troubleshooting

Workflows needs your AI tool to have been launched at least once to set up its directories. Open Claude Code (or Cursor), close it, then re-run jog init.
Re-run jog init and select Set up guided workflows (GG). Make sure you select the same AI tool you use day-to-day.