Skip to main content

Ramble Configuration

Field Definitions

Configure extractable fields in ~/.ramble/fields.yml:

fields:
- name: title
description: A concise title for the item
type: string
required: true

- name: type
description: The type of item (feature, bug, task, idea)
type: enum
values: [feature, bug, task, idea]
default: feature

- name: priority
description: Urgency level
type: enum
values: [low, medium, high, critical]
default: medium

- name: description
description: Detailed description
type: string
multiline: true

- name: acceptance_criteria
description: List of criteria for completion
type: list
item_type: string

- name: tags
description: Relevant tags or categories
type: list
item_type: string

Provider Configuration

Set up AI providers in ~/.ramble/config.yml:

provider:
name: claude # or codex, gemini, mock

claude:
api_key: ${ANTHROPIC_API_KEY}
model: claude-sonnet-4-20250514

codex:
api_key: ${OPENAI_API_KEY}
model: gpt-4

gemini:
api_key: ${GOOGLE_API_KEY}
model: gemini-pro

# For testing without API calls
mock:
delay: 0.5 # Simulate response delay

Output Configuration

output:
format: json # json, yaml, markdown
directory: ./output
filename_template: "{type}-{timestamp}"

# PlantUML diagram generation
diagram:
enabled: true
type: usecase # usecase, sequence, class
server: http://www.plantuml.com/plantuml

GUI Settings

gui:
theme: dark # dark, light, system
font_size: 12
window:
width: 800
height: 600
remember_position: true

Environment Variables

VariablePurpose
ANTHROPIC_API_KEYClaude API key
OPENAI_API_KEYOpenAI/Codex API key
GOOGLE_API_KEYGemini API key
RAMBLE_PROVIDERDefault provider override
RAMBLE_CONFIGCustom config file path