Skip to content

Commit 68f68c5

Browse files
committed
chore: docs update
1 parent 36ce62b commit 68f68c5

2 files changed

Lines changed: 39 additions & 14 deletions

File tree

README.md

Lines changed: 36 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -84,21 +84,24 @@ Run `glooit sync` (or `bunx glooit sync` / `npx glooit sync`) and it creates:
8484
| `cursor` | `.cursor/rules/{name}.mdc` | Frontmatter |
8585
| `codex` | `AGENTS.md` | Markdown |
8686
| `opencode` | `AGENTS.md` | Markdown |
87+
| `factory` | `AGENTS.md` | Markdown |
8788
| `roocode` | `.roo/rules/{name}.md` | Markdown |
8889
| `generic` | `{name}.md` | Markdown |
8990

9091
### Feature Support Matrix
9192

92-
| Feature | Claude | Cursor | OpenCode | Codex | Roo Code/Cline | Generic |
93-
|-------------|--------|--------|----------|-------|----------------|---------|
94-
| Rules |||||||
95-
| Commands |||| - | - | - |
96-
| Skills |||* | - | - | - |
97-
| Agents |||| - | - | - |
98-
| MCP Servers |||||||
99-
| Hooks ||| - | - | - | - |
93+
| Feature | Claude | Cursor | OpenCode | Codex | Factory | Roo Code/Cline | Generic |
94+
|-------------|--------|--------|----------|-------|---------|----------------|---------|
95+
| Rules |||||| ||
96+
| Commands |||| * | - | - | - |
97+
| Skills |||** || | - | - |
98+
| Agents |||| - | *** | - | - |
99+
| MCP Servers |||||| ||
100+
| Hooks ||| - | - | | - | - |
100101

101-
*OpenCode uses Claude-compatible skills path (`.claude/skills/`)
102+
*Codex uses `.codex/prompts` for commands
103+
**OpenCode uses Claude-compatible skills path (`.claude/skills/`)
104+
***Factory uses "droids" (`.factory/droids/`) for agents
102105

103106
## Features
104107

@@ -143,9 +146,9 @@ export default defineRules({
143146

144147
Output mappings:
145148

146-
- `commands``.claude/commands`, `.cursor/commands`, `.opencode/command`
147-
- `skills``.claude/skills`, `.cursor/skills` (OpenCode uses `.claude/skills`)
148-
- `agents``.claude/agents`, `.cursor/agents`, `.opencode/agent`
149+
- `commands``.claude/commands`, `.cursor/commands`, `.opencode/command`, `.codex/prompts`
150+
- `skills``.claude/skills`, `.cursor/skills`, `.codex/skills`, `.factory/skills` (OpenCode uses `.claude/skills`)
151+
- `agents``.claude/agents`, `.cursor/agents`, `.opencode/agent`, `.factory/droids`
149152

150153
### Symlink Mode
151154

@@ -171,12 +174,14 @@ export default defineRules({
171174
```
172175

173176
**Why use symlink mode?**
177+
174178
- Changes to source files instantly reflect in all agent configs (no need to run `glooit sync`)
175179
- Single source of truth - edit once, all agents see the update
176180
- Useful for rapid iteration and development
177181

178182
**Limitations:**
179183
Symlinks point directly to source files, so transformations cannot be applied:
184+
180185
- Per-rule hooks and global transforms are skipped (hooks/transforms would modify the source file)
181186
- Merge rules (`file: string[]`) automatically fall back to copy mode (cannot symlink to multiple files)
182187
- Agent-specific formatting is not applied (each agent would need a different version)
@@ -357,6 +362,7 @@ export default defineRules({
357362
```bash
358363
glooit init # Initialize configuration
359364
glooit sync # Sync rules and MCPs
365+
glooit link # Zero-config symlink sync (no config file needed)
360366
glooit unlink # Replace symlinked outputs with real files
361367
glooit validate # Validate configuration
362368
glooit clean # Clean .gitignore entries
@@ -366,6 +372,24 @@ glooit backup list # List available backups
366372
glooit backup restore <timestamp> # Restore from backup
367373
```
368374

375+
### Link Command
376+
377+
The `link` command provides zero-config symlink-based syncing without requiring a config file:
378+
379+
```bash
380+
glooit link # Auto-detect .agents/ or .glooit/ and sync to all agents
381+
glooit link .my-rules # Use custom source directory
382+
glooit link -t claude,cursor # Sync to specific agents only
383+
```
384+
385+
It automatically discovers and symlinks:
386+
387+
- `CLAUDE.md` → Claude Code
388+
- `AGENTS.md` → Codex, OpenCode, Factory
389+
- `commands/` → All agents that support commands
390+
- `skills/` → All agents that support skills
391+
- `agents/` → All agents that support agents/droids
392+
369393
### Upgrade
370394

371395
The `upgrade` command auto-detects your package manager and whether glooit is installed locally or globally:

tests/unit/validation-extra.test.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,11 @@ describe('ConfigValidator extra cases', () => {
4040
});
4141

4242
it('flags directory path that is not a directory', async () => {
43-
writeFileSync('not-a-dir', 'content');
43+
const notADirPath = `${testDir}/not-a-dir`;
44+
writeFileSync(notADirPath, 'content');
4445
const config: Config = {
4546
rules: [],
46-
commands: 'not-a-dir'
47+
commands: notADirPath
4748
};
4849

4950
const errors = await ConfigValidator.validate(config);

0 commit comments

Comments
 (0)