Skip to content

About

A DDEV add-on that integrates the Decodie learning companion into your local development environment.

Topics

Resources

Stars

5 stars

Watchers

0 watching

Forks

Repository files navigation

Decodie

Decodie DDEV Add-on

A DDEV add-on that integrates the Decodie learning companion into your local development environment.

Requirements

  • DDEV v1.22+

Installation

ddev add-on get owenbush/decodie-ddev
ddev restart
ddev decodie

This installs everything you need:

  • The Decodie UI (via npm)
  • The Decodie commands for Claude Code (into ~/.claude/commands/decodie/)

The UI will be available at https://decodie.SITENAME.ddev.site (where SITENAME is your DDEV project name).

To start generating learning entries, run /decodie:observe in Claude Code at the start of your session. You can also run /decodie:analyze src/ to generate entries from existing code, or /decodie:ask "question" to query your entries.

Usage

ddev decodie            # Open in your browser
ddev decodie status     # Show entry statistics
ddev decodie cleanup    # Open the archival review page
ddev decodie help       # Show available commands

Q&A Configuration

The Q&A feature requires authentication with Claude. Edit .ddev/decodie/.env and set one of the following:

Option A: OAuth token (recommended -- uses your Claude subscription)

  1. On your host machine (not inside DDEV), run: claude setup-token
  2. Copy the token and add it to .ddev/decodie/.env:
    CLAUDE_CODE_OAUTH_TOKEN=sk-ant-oat01-...
    
  3. ddev restart

Option B: API key

  1. Get a key from console.anthropic.com
  2. Add it to .ddev/decodie/.env:
    CLAUDE_API_KEY=sk-ant-...
    
  3. ddev restart

How It Works

The add-on installs @owenbush/decodie-ui from npm and runs it as a daemon inside the DDEV web container. Traefik handles subdomain routing. No separate container is needed.

To update to the latest version of the UI:

ddev exec "cd /var/www/html/.ddev/decodie && npm update @owenbush/decodie-ui"
ddev restart

Related Repositories

About

A DDEV add-on that integrates the Decodie learning companion into your local development environment.

Topics

Resources

Stars

5 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages