Skip to content

Commit 5c425e0

Browse files
authored
Merge pull request #47 from myk-org/feat/uvx-docsfy-fallback
feat(skill): support uvx docsfy fallback when CLI not installed
2 parents 017d30f + c500900 commit 5c425e0

2 files changed

Lines changed: 8 additions & 4 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
/home/myakove/git/docsfy/CLAUDE.md
1+
CLAUDE.md

skills/docsfy-generate-docs/SKILL.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,14 @@ Generate AI-powered documentation for a Git repository using the docsfy CLI. The
1111

1212
## Prerequisites (MANDATORY - check before anything else)
1313

14-
### 1. docsfy CLI installed
14+
### 1. Check docsfy CLI
1515

1616
```bash
1717
docsfy --help
1818
```
1919

20-
If not found: `uv tool install docsfy`
20+
If not found, use `uvx docsfy` as the command prefix for all `docsfy` commands in this document.
21+
If `uvx` is also not available: `uv tool install docsfy`
2122

2223
### 2. Server is alive
2324

@@ -26,7 +27,7 @@ docsfy health
2627
```
2728

2829
If health check fails, inform the user that the docsfy server is not reachable and stop. The user may need to:
29-
- Start the server: `docsfy-server`
30+
- Start the server: `docsfy-server` (or `uvx --from docsfy docsfy-server`)
3031
- Check their config: `docsfy config show`
3132
- Set up a profile: `docsfy config init`
3233

@@ -105,6 +106,8 @@ Display:
105106
106107
## Quick Reference
107108
109+
> If `docsfy` is not installed, prefix commands with `uvx` (e.g., `uvx docsfy health`).
110+
108111
| Command | Purpose |
109112
|---------|---------|
110113
| `docsfy generate <url> --watch` | Generate docs with live progress |
@@ -126,3 +129,4 @@ Display:
126129
| Forgetting `--watch` flag | Always use `--watch` for real-time progress |
127130
| Downloading before ready | Check status is `ready` before downloading |
128131
| Leaving nested download folder | Flatten after download — move files to output root |
132+
| Assuming docsfy is installed | Use `uvx docsfy` when CLI is missing but uv is available |

0 commit comments

Comments
 (0)