You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CLAUDE.md
+11-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,16 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
4
4
5
5
## Overview
6
6
7
-
**markdown-agent** (`ma`) is a CLI tool that executes AI agents defined as markdown files. It parses YAML frontmatter for configuration and passes keys directly as CLI flags to the specified command (claude, codex, gemini, copilot, or any other CLI tool).
7
+
**mdflow** (`md`) is a CLI tool that executes AI agents defined as markdown files. It parses YAML frontmatter for configuration and passes keys directly as CLI flags to the specified command (claude, codex, gemini, copilot, or any other CLI tool).
8
8
9
9
## CLI Subcommands
10
10
11
11
```bash
12
-
ma<file.md> [flags] # Run an agent
13
-
ma create [name] # Create a new agent file
14
-
ma setup # Configure shell (PATH, aliases)
15
-
ma logs # Show agent log directory
16
-
mahelp# Show help
12
+
md<file.md> [flags] # Run an agent
13
+
md create [name] # Create a new agent file
14
+
md setup # Configure shell (PATH, aliases)
15
+
md logs # Show agent log directory
16
+
mdhelp# Show help
17
17
```
18
18
19
19
## Development Commands
@@ -32,7 +32,7 @@ bun test --test-name-pattern "parses command"
32
32
bun run src/index.ts task.claude.md
33
33
34
34
# Or using the alias
35
-
bun run ma task.claude.md
35
+
bun run md task.claude.md
36
36
```
37
37
38
38
## Architecture
@@ -56,7 +56,7 @@ bun run ma task.claude.md
56
56
-`runCommand()`: Spawns the command with positional args
57
57
58
58
-**`config.ts`** - Global configuration
59
-
- Loads defaults from `~/.markdown-agent/config.yaml`
59
+
- Loads defaults from `~/.mdflow/config.yaml`
60
60
- Built-in defaults: All commands default to print mode
61
61
-`getCommandDefaults()`: Get defaults for a command
62
62
-`applyDefaults()`: Merge defaults with frontmatter
@@ -80,7 +80,7 @@ bun run ma task.claude.md
80
80
81
81
-**`template.ts`** - LiquidJS-powered template engine for variable substitution
82
82
83
-
-**`logger.ts`** - Structured logging with pino (logs to `~/.markdown-agent/logs/<agent>/`)
83
+
-**`logger.ts`** - Structured logging with pino (logs to `~/.mdflow/logs/<agent>/`)
84
84
85
85
### Command Resolution
86
86
@@ -90,7 +90,7 @@ Commands are resolved in priority order:
90
90
91
91
### Frontmatter Keys
92
92
93
-
**System keys** (consumed by ma, not passed to command):
93
+
**System keys** (consumed by md, not passed to command):
94
94
-`args`: Named positional arguments for template vars
95
95
-`env` (object form): Sets process.env before execution
Copy file name to clipboardExpand all lines: README.md
+46-46Lines changed: 46 additions & 46 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# markdown-agent
1
+
# mdflow
2
2
3
3
```bash
4
4
review.claude.md # Run with Claude
@@ -67,7 +67,7 @@ The markdown body is passed as the final argument to the command.
67
67
68
68
## Unix Philosophy
69
69
70
-
markdown-agent embraces the Unix philosophy:
70
+
mdflow embraces the Unix philosophy:
71
71
72
72
-**No magic mapping** - Frontmatter keys pass directly to the command
73
73
-**Stdin/stdout** - Pipe data in and out
@@ -76,18 +76,18 @@ markdown-agent embraces the Unix philosophy:
76
76
77
77
```bash
78
78
# Pipe input
79
-
git diff |ma review.claude.md
79
+
git diff |mdflow review.claude.md
80
80
81
81
# Chain agents
82
-
ma plan.claude.md |ma implement.codex.md
82
+
mdflow plan.claude.md |mdflow implement.codex.md
83
83
```
84
84
85
85
---
86
86
87
87
## Installation
88
88
89
89
```bash
90
-
npm install -g markdown-agent
90
+
npm install -g mdflow
91
91
# or
92
92
bun install && bun link
93
93
```
@@ -96,18 +96,18 @@ bun install && bun link
96
96
97
97
```bash
98
98
# Run with filename-inferred command
99
-
ma task.claude.md
100
-
ma task.gemini.md
99
+
mdflow task.claude.md
100
+
mdflow task.gemini.md
101
101
102
102
# Override command via --command flag
103
-
ma task.md --command claude
104
-
ma task.md -c gemini
103
+
mdflow task.md --command claude
104
+
mdflow task.md -c gemini
105
105
106
106
# Pass additional flags to the command
107
-
ma task.claude.md --verbose --debug
107
+
mdflow task.claude.md --verbose --debug
108
108
```
109
109
110
-
> **Note:** Both `ma` and `markdown-agent` commands are available.
110
+
> **Note:** Both `mdflow` and `md` commands are available.
111
111
112
112
---
113
113
@@ -124,19 +124,19 @@ If no command can be resolved, you'll get an error with instructions.
124
124
125
125
## Flag Hijacking
126
126
127
-
Some CLI flags are "hijacked" by markdown-agent—they're consumed and never passed to the underlying command. This allows generic markdown files without command names to be executed.
127
+
Some CLI flags are "hijacked" by mdflow—they're consumed and never passed to the underlying command. This allows generic markdown files without command names to be executed.
128
128
129
129
### `--command` / `-c`
130
130
131
131
Override the command for any markdown file:
132
132
133
133
```bash
134
134
# Run a generic .md file with any command
135
-
ma task.md --command claude
136
-
ma task.md -c gemini
135
+
mdflow task.md --command claude
136
+
mdflow task.md -c gemini
137
137
138
138
# Override the filename-inferred command
139
-
ma task.claude.md --command gemini # Runs gemini, not claude
139
+
mdflow task.claude.md --command gemini # Runs gemini, not claude
0 commit comments