Skip to content

setup.md

Latest commit

 

History

History
89 lines (57 loc) · 2.67 KB

setup.md

File metadata and controls

89 lines (57 loc) · 2.67 KB

Setup

Prerequisites

  • Bun v1.x+
  • A markdown vault (any folder with .md files -- Obsidian works great but is not required)

Authentication

worklog supports two AI providers. Select one during worklog init.

Anthropic (Claude) — default

Uses the Claude Agent SDK. Two ways to authenticate:

API key

export ANTHROPIC_API_KEY="sk-ant-..."
worklog init                # select "Anthropic (Claude)"

Get an API key at https://console.anthropic.com/settings/keys

Claude Code CLI

If you already have Claude Code installed and authenticated, worklog piggybacks off your existing session — no extra setup needed.

claude /doctor              # verify Claude Code is working
worklog init                # select "Anthropic (Claude)"

OpenAI

ChatGPT subscription (recommended)

Use your existing ChatGPT Plus, Business, or Pro plan. No separate API billing.

npx codex@latest login    # opens browser — sign in with your ChatGPT account
worklog init               # select "OpenAI"

Tokens cache locally at ~/.codex/auth.json and refresh automatically.

API key

For direct API billing through the OpenAI Platform.

export OPENAI_API_KEY="sk-..."
worklog init               # select "OpenAI"

Get an API key at https://platform.openai.com/api-keys

Environment variables

Variable Required for How to get it
ATLASSIAN_API_TOKEN Jira/Confluence data Atlassian API tokens
GITHUB_TOKEN GitHub PR data GitHub tokens
ANTHROPIC_API_KEY AI — Anthropic (if not using Claude Code CLI) Anthropic console
OPENAI_API_KEY AI — OpenAI (if not using ChatGPT subscription) OpenAI dashboard

First-time setup

worklog init

This walks you through vault location, API connections, authentication, profile, and career setup.

After init, three markdown files appear in your vault:

  • my-profile.md -- your background, skills, growth areas
  • work-context.md -- company values, review cycle, org context
  • coach-persona.md -- how coaching feedback is delivered

These are plain markdown -- edit them anytime to refine the AI's context.

Configuration

Config is stored at ~/.config/worklog/config.json (XDG standard).

Adjacent files:

  • ~/.config/worklog/team-timeline.json -- team history
  • ~/.config/worklog/worklog-stats.json -- run timing statistics