Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
229 changes: 85 additions & 144 deletions README.md

Large diffs are not rendered by default.

48 changes: 48 additions & 0 deletions docs/agent-workflow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Use Oatmeal with your coding agent

Oatmeal's MCP server reads Markdown files from `meetings/` by default. It exposes three tools: `list_meetings`, `search_meetings`, and `get_meeting`. This is the original file-based workflow, separate from the desktop app's internal meeting storage.

To use desktop meetings with it, export the meeting as Markdown into `meetings/` or set `OATMEAL_MEETINGS_DIR` to your export directory. Requests through a coding agent follow that agent's data and billing settings; reading a local file into a cloud agent may send its content to that provider.

## Claude Code

Install repository dependencies, then register the server using an absolute path:

```sh
claude mcp add oatmeal -- node /absolute/path/to/oatmeal/scripts/mcp-server.mjs
```

The repository also includes `.mcp.json`, Claude skills, and commands. Review and trust project configuration before enabling it.

## Cursor or another MCP client

Add this entry to your client's MCP configuration, replacing both paths with your own:

```json
{
"mcpServers": {
"oatmeal": {
"command": "node",
"args": ["/absolute/path/to/oatmeal/scripts/mcp-server.mjs"],
"env": {
"OATMEAL_MEETINGS_DIR": "/absolute/path/to/meeting-exports"
}
}
}
}
```

Ask the agent to list your meetings, search for a decision, or read a meeting file. It can only return files that exist in the configured folder.

## Original browser recorder

The `main` branch retains the original browser workflow while the desktop preview is reviewed:

```sh
npm install
node capture/server.mjs
```

Open `http://localhost:4123`. Record in the browser; transcripts are saved as Markdown in `meetings/`. On the desktop branch, the equivalent command is `npm run start:browser`.

For the complete original workflow, see [the legacy guide](https://github.com/VedSoni-dev/oatmeal/blob/codex/desktop-app/docs/legacy-agent-workflow.md).
12 changes: 12 additions & 0 deletions docs/assets/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Documentation assets

- `oatmeal-notebook.png`, `oatmeal-settings.png`: screenshots of the actual desktop preview, captured with an isolated profile and fictional meeting data.
- `oatmeal-demo.gif`: a ten-second UI walkthrough through notes, transcript, and a prepared summary. It does not depict live recording or model generation.
- `oatmeal-icon.svg`: Oatmeal's own icon, covered by the repository's MIT license.
- `logos/`: Cursor, Claude, OpenRouter, Ollama, Hugging Face, and Electron marks from [Simple Icons](https://github.com/simple-icons/simple-icons/tree/develop/icons), retrieved October 5, 2026. The collection is released under [CC0](https://github.com/simple-icons/simple-icons/blob/develop/LICENSE.md); trademarks remain with their owners. `-light` variants use a monochrome fill for dark-background legibility; proportions are unchanged.

- `logos/openai.png`: the OpenAI organization’s public GitHub avatar, retrieved through the [GitHub organization API](https://api.github.com/orgs/openai). The mark belongs to OpenAI and identifies the Codex workflow.

Logos identify actual integrations, the optional agent workflow, and the desktop framework. They do not denote partnerships or endorsements. Claude's mark identifies both Claude and the Claude Code workflow.

Regenerate the screenshots and GIF from the desktop branch with `node scripts/capture-showcase.mjs` after installing dependencies and `ffmpeg`. It uses only fictional data and makes no audio or AI requests.
1 change: 1 addition & 0 deletions docs/assets/logos/claude-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/logos/claude.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/logos/cursor-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/logos/cursor.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/logos/electron-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/logos/electron.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/logos/huggingface-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/assets/logos/huggingface.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading