mirror of
https://github.com/openclaw/clawhub.git
synced 2026-08-14 00:47:57 +00:00
chore: remove docs page link
This commit is contained in:
+7
-8
@@ -11,14 +11,13 @@ Reading order (new contributor):
|
||||
|
||||
1. `README.md` (repo root): run locally.
|
||||
2. `docs/quickstart.md`: end-to-end: search → install → publish → sync.
|
||||
3. `docs/usage.md`: CLI usage across any folder layout.
|
||||
4. `docs/architecture.md`: how the pieces fit (TanStack Start + Convex + CLI).
|
||||
5. `docs/skill-format.md`: what a “skill” is on disk + on the registry.
|
||||
6. `docs/cli.md`: CLI reference (flags, config, lockfiles, sync rules).
|
||||
7. `docs/http-api.md`: HTTP endpoints used by the CLI + public API.
|
||||
8. `docs/auth.md`: GitHub OAuth + API tokens + CLI loopback login.
|
||||
9. `docs/deploy.md`: Convex + Vercel deployment + rewrites.
|
||||
10. `docs/troubleshooting.md`: common failure modes.
|
||||
3. `docs/architecture.md`: how the pieces fit (TanStack Start + Convex + CLI).
|
||||
4. `docs/skill-format.md`: what a “skill” is on disk + on the registry.
|
||||
5. `docs/cli.md`: CLI reference (flags, config, lockfiles, sync rules).
|
||||
6. `docs/http-api.md`: HTTP endpoints used by the CLI + public API.
|
||||
7. `docs/auth.md`: GitHub OAuth + API tokens + CLI loopback login.
|
||||
8. `docs/deploy.md`: Convex + Vercel deployment + rewrites.
|
||||
9. `docs/troubleshooting.md`: common failure modes.
|
||||
|
||||
Feature/ops docs (already present):
|
||||
|
||||
|
||||
@@ -1,81 +0,0 @@
|
||||
---
|
||||
summary: 'How to use the CLI in any setup (search, install, sync, publish).'
|
||||
read_when:
|
||||
- Learning the CLI workflow
|
||||
- Explaining install/sync to users
|
||||
---
|
||||
|
||||
# CLI usage (works anywhere)
|
||||
|
||||
ClawdHub is folder-agnostic. You can run it from any directory, even if there are no skills there yet.
|
||||
|
||||
## Choose where skills live
|
||||
|
||||
Use `--workdir` to pick *any* folder as your base, and `--dir` to choose the subfolder where skills install.
|
||||
|
||||
Examples:
|
||||
|
||||
```bash
|
||||
clawdhub install gifgrep --workdir /tmp/demo --dir skills
|
||||
clawdhub list --workdir /tmp/demo --dir skills
|
||||
```
|
||||
|
||||
## Search
|
||||
|
||||
```bash
|
||||
clawdhub search gif --limit 5
|
||||
```
|
||||
|
||||
## Install
|
||||
|
||||
Install the latest version into `<workdir>/<dir>/<slug>` (default: `./skills/<slug>`):
|
||||
|
||||
```bash
|
||||
clawdhub install gifgrep
|
||||
```
|
||||
|
||||
## List
|
||||
|
||||
```bash
|
||||
clawdhub list
|
||||
```
|
||||
|
||||
## Update
|
||||
|
||||
```bash
|
||||
clawdhub update --all
|
||||
```
|
||||
|
||||
## Sync (publish local skills)
|
||||
|
||||
`sync` scans for local skills and publishes new/changed ones.
|
||||
|
||||
You can point it at *any* folder:
|
||||
|
||||
- a **skills root** that contains multiple skill folders
|
||||
- a **single skill folder** (with `SKILL.md`)
|
||||
|
||||
Examples:
|
||||
|
||||
```bash
|
||||
clawdhub sync --root /path/to/skills
|
||||
clawdhub sync --root /path/to/skills/1password --all --changelog "Update tmux flow"
|
||||
```
|
||||
|
||||
If the workdir has no skills, `sync` automatically checks known fallback locations.
|
||||
|
||||
## Publish (single skill)
|
||||
|
||||
```bash
|
||||
clawdhub publish /path/to/skill \
|
||||
--slug my-skill \
|
||||
--name "My Skill" \
|
||||
--version 1.0.0 \
|
||||
--changelog "Initial release"
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
- Skill folders require `SKILL.md` (or `skill.md`).
|
||||
- Config is stored in `~/Library/Application Support/clawdhub/config.json` (override with `CLAWDHUB_CONFIG_PATH`).
|
||||
- You can always override registry/site with `--registry` and `--site`.
|
||||
@@ -14,10 +14,6 @@ export function Footer() {
|
||||
Open source (MIT)
|
||||
</a>{' '}
|
||||
·{' '}
|
||||
<a href="https://docs.clawdhub.com" target="_blank" rel="noreferrer">
|
||||
Docs
|
||||
</a>{' '}
|
||||
·{' '}
|
||||
<a href="https://steipete.me" target="_blank" rel="noreferrer">
|
||||
Peter Steinberger
|
||||
</a>
|
||||
|
||||
@@ -69,9 +69,6 @@ export default function Header() {
|
||||
<Link to="/search" search={{ q: undefined, highlighted: undefined }}>
|
||||
Search
|
||||
</Link>
|
||||
<a href="https://docs.clawdhub.com" target="_blank" rel="noreferrer">
|
||||
Docs
|
||||
</a>
|
||||
{me ? <Link to="/stars">Stars</Link> : null}
|
||||
{isModerator ? <Link to="/admin">Admin</Link> : null}
|
||||
</nav>
|
||||
@@ -108,11 +105,6 @@ export default function Header() {
|
||||
Search
|
||||
</Link>
|
||||
</DropdownMenuItem>
|
||||
<DropdownMenuItem asChild>
|
||||
<a href="https://docs.clawdhub.com" target="_blank" rel="noreferrer">
|
||||
Docs
|
||||
</a>
|
||||
</DropdownMenuItem>
|
||||
{me ? (
|
||||
<DropdownMenuItem asChild>
|
||||
<Link to="/stars">Stars</Link>
|
||||
|
||||
Reference in New Issue
Block a user