1 line
5.2 KiB
JavaScript
1 line
5.2 KiB
JavaScript
"use strict";(globalThis.webpackChunkproject_public_docs=globalThis.webpackChunkproject_public_docs||[]).push([[873],{8453(e,n,i){i.d(n,{R:()=>o,x:()=>d});var t=i(6540);const r={},s=t.createContext(r);function o(e){const n=t.useContext(s);return t.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function d(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:o(e.components),t.createElement(s.Provider,{value:n},e.children)}},8633(e,n,i){i.r(n),i.d(n,{assets:()=>l,contentTitle:()=>d,default:()=>u,frontMatter:()=>o,metadata:()=>t,toc:()=>a});const t=JSON.parse('{"id":"configuration","title":"Ramble Configuration","description":"Field Definitions","source":"@site/docs/configuration.md","sourceDirName":".","slug":"/configuration","permalink":"/rob/ramble/configuration","draft":false,"unlisted":false,"tags":[],"version":"current","sidebarPosition":2,"frontMatter":{"sidebar_position":2},"sidebar":"docs","previous":{"title":"Ramble Overview","permalink":"/rob/ramble/"}}');var r=i(4848),s=i(8453);const o={sidebar_position:2},d="Ramble Configuration",l={},a=[{value:"Field Definitions",id:"field-definitions",level:2},{value:"Provider Configuration",id:"provider-configuration",level:2},{value:"Output Configuration",id:"output-configuration",level:2},{value:"GUI Settings",id:"gui-settings",level:2},{value:"Environment Variables",id:"environment-variables",level:2}];function c(e){const n={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,s.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"ramble-configuration",children:"Ramble Configuration"})}),"\n",(0,r.jsx)(n.h2,{id:"field-definitions",children:"Field Definitions"}),"\n",(0,r.jsxs)(n.p,{children:["Configure extractable fields in ",(0,r.jsx)(n.code,{children:"~/.ramble/fields.yml"}),":"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"fields:\n - name: title\n description: A concise title for the item\n type: string\n required: true\n\n - name: type\n description: The type of item (feature, bug, task, idea)\n type: enum\n values: [feature, bug, task, idea]\n default: feature\n\n - name: priority\n description: Urgency level\n type: enum\n values: [low, medium, high, critical]\n default: medium\n\n - name: description\n description: Detailed description\n type: string\n multiline: true\n\n - name: acceptance_criteria\n description: List of criteria for completion\n type: list\n item_type: string\n\n - name: tags\n description: Relevant tags or categories\n type: list\n item_type: string\n"})}),"\n",(0,r.jsx)(n.h2,{id:"provider-configuration",children:"Provider Configuration"}),"\n",(0,r.jsxs)(n.p,{children:["Set up AI providers in ",(0,r.jsx)(n.code,{children:"~/.ramble/config.yml"}),":"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"provider:\n name: claude # or codex, gemini, mock\n\nclaude:\n api_key: ${ANTHROPIC_API_KEY}\n model: claude-sonnet-4-20250514\n\ncodex:\n api_key: ${OPENAI_API_KEY}\n model: gpt-4\n\ngemini:\n api_key: ${GOOGLE_API_KEY}\n model: gemini-pro\n\n# For testing without API calls\nmock:\n delay: 0.5 # Simulate response delay\n"})}),"\n",(0,r.jsx)(n.h2,{id:"output-configuration",children:"Output Configuration"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:'output:\n format: json # json, yaml, markdown\n directory: ./output\n filename_template: "{type}-{timestamp}"\n\n # PlantUML diagram generation\n diagram:\n enabled: true\n type: usecase # usecase, sequence, class\n server: http://www.plantuml.com/plantuml\n'})}),"\n",(0,r.jsx)(n.h2,{id:"gui-settings",children:"GUI Settings"}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-yaml",children:"gui:\n theme: dark # dark, light, system\n font_size: 12\n window:\n width: 800\n height: 600\n remember_position: true\n"})}),"\n",(0,r.jsx)(n.h2,{id:"environment-variables",children:"Environment Variables"}),"\n",(0,r.jsxs)(n.table,{children:[(0,r.jsx)(n.thead,{children:(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.th,{children:"Variable"}),(0,r.jsx)(n.th,{children:"Purpose"})]})}),(0,r.jsxs)(n.tbody,{children:[(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"ANTHROPIC_API_KEY"})}),(0,r.jsx)(n.td,{children:"Claude API key"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"OPENAI_API_KEY"})}),(0,r.jsx)(n.td,{children:"OpenAI/Codex API key"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"GOOGLE_API_KEY"})}),(0,r.jsx)(n.td,{children:"Gemini API key"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"RAMBLE_PROVIDER"})}),(0,r.jsx)(n.td,{children:"Default provider override"})]}),(0,r.jsxs)(n.tr,{children:[(0,r.jsx)(n.td,{children:(0,r.jsx)(n.code,{children:"RAMBLE_CONFIG"})}),(0,r.jsx)(n.td,{children:"Custom config file path"})]})]})]})]})}function u(e={}){const{wrapper:n}={...(0,s.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(c,{...e})}):c(e)}}}]); |