Skip to content

User Guide

Welcome to the HtmlGraph user guide. This section provides in-depth documentation for all HtmlGraph features.

What You'll Learn

This guide covers:

  • Features & Tracks - Creating and managing features and tracks
  • TrackBuilder - Mastering the TrackBuilder fluent API
  • Sessions - Understanding session tracking and attribution
  • Agents - Integrating HtmlGraph with AI agents
  • Dashboard - Using the interactive dashboard

Quick Navigation

For Beginners

Start with these guides in order:

  1. Features & Tracks - Learn the basics
  2. Dashboard - Visualize your work
  3. Sessions - Understand activity tracking

For Agent Developers

Jump to these sections:

  1. Agents - Agent integration patterns
  2. TrackBuilder - Deterministic track creation
  3. Sessions - Session management and attribution

For Power Users

Advanced topics:

  1. TrackBuilder - Complex track workflows
  2. Sessions - Custom session handling
  3. API Reference - Complete API documentation

Common Workflows

Creating a Simple Feature

from htmlgraph import SDK

sdk = SDK(agent="claude")
feature = sdk.features.create(
    title="Add login page",
    priority="high",
    steps=["Create component", "Add routing", "Write tests"]
)

Learn more →

Creating a Complex Track

track = sdk.tracks.builder() \
    .title("User Authentication") \
    .with_spec(overview="Full auth system") \
    .with_plan_phases([
        ("Phase 1", ["OAuth setup (2h)", "JWT middleware (3h)"])
    ]) \
    .create()

Learn more →

Linking Features to Tracks

# Create features for the track
auth_feature = sdk.features.create(
    title="OAuth Setup",
    track_id=track.track_id
)

jwt_feature = sdk.features.create(
    title="JWT Middleware",
    track_id=track.track_id
)

Learn more →

Starting a Session

Sessions are automatically managed by HtmlGraph hooks:

# Session starts automatically when you begin working
htmlgraph feature start feature-001

# View session status
htmlgraph status

# Session ends automatically when you complete the feature
htmlgraph feature complete feature-001

Learn more →

Need Help?