Skip to content

Commit 8f7fe68

Browse files
committed
docs: update all references from skillx to skillx-sh npm package
1 parent 4e27faf commit 8f7fe68

File tree

9 files changed

+22
-18
lines changed

9 files changed

+22
-18
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,23 @@ cd apps/web && pnpm dev
2222
### CLI Tool
2323

2424
```bash
25+
# Install globally
26+
npm install -g skillx-sh
27+
2528
# Search for skills
26-
npx skillx search "data processing"
29+
skillx search "data processing"
2730

2831
# Use a skill
29-
npx skillx use skillx-search
32+
skillx use skillx-search
3033

3134
# Search and use in one command
32-
npx skillx use "data processing" --search
35+
skillx use "data processing" --search
3336

3437
# Report execution result
35-
npx skillx report --outcome success --duration 1234
38+
skillx report --outcome success --duration 1234
3639

3740
# Configure API key
38-
npx skillx config set SKILLX_API_KEY sk_prod_...
41+
skillx config set SKILLX_API_KEY sk_prod_...
3942
```
4043

4144
## What is SkillX?

apps/web/app/components/skill-card.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export function SkillCard({
2323
rating,
2424
}: SkillCardProps) {
2525
const [copied, setCopied] = useState(false);
26-
const installCommand = `npx skillx install ${slug}`;
26+
const installCommand = `npx skillx-sh use ${slug}`;
2727

2828
const handleCopy = async (e: React.MouseEvent) => {
2929
e.preventDefault();

apps/web/app/lib/github/fetch-github-skill.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ export async function fetchGitHubSkill(
122122
author: repoData.owner.login,
123123
source_url: repoData.html_url,
124124
category: inferCategory(repoData.topics || []),
125-
install_command: `npx skillx use ${owner}/${repo}`,
125+
install_command: `npx skillx-sh use ${owner}/${repo}`,
126126
github_stars: repoData.stargazers_count,
127127
};
128128
}

apps/web/app/routes/docs.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ export default function Docs() {
3535
Install SkillX globally or run it directly with npx.
3636
</p>
3737
<div className="space-y-3">
38-
<CommandBox command="npm install -g skillx" />
38+
<CommandBox command="npm install -g skillx-sh" />
3939
<p className="text-center text-xs text-sx-fg-subtle">or use without installing:</p>
40-
<CommandBox command="npx skillx --help" />
40+
<CommandBox command="npx skillx-sh --help" />
4141
</div>
4242
</div>
4343

apps/web/app/routes/home.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ export default function Home({ loaderData }: Route.ComponentProps) {
107107
<p className="mb-1.5 text-left font-mono text-xs text-sx-fg-muted">
108108
Then use it:
109109
</p>
110-
<CommandBox command='npx skillx use "deploy to cloudflare" --search' />
110+
<CommandBox command='npx skillx-sh use "deploy to cloudflare" --search' />
111111
</div>
112112
</div>
113113

apps/web/app/routes/skill-detail.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ export default function SkillDetail() {
7979
);
8080
};
8181

82-
const installCmd = data.skill.install_command || `npx skillx install ${data.skill.slug}`;
82+
const installCmd = data.skill.install_command || `npx skillx-sh use ${data.skill.slug}`;
8383

8484
return (
8585
<PageContainer>

docs/codebase-summary.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -176,10 +176,11 @@ skillx/
176176

177177
**Usage:**
178178
```bash
179-
npx skillx search "data processing"
180-
npx skillx use skillx-search skillx-email
181-
npx skillx config set SKILLX_API_KEY sk_...
182-
npx skillx report --outcome success --duration 1234
179+
npm install -g skillx-sh
180+
skillx search "data processing"
181+
skillx use skillx-search skillx-email
182+
skillx config set SKILLX_API_KEY sk_...
183+
skillx report --outcome success --duration 1234
183184
```
184185

185186
## Data Flow Diagrams (ASCII)

docs/design-guidelines.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Layout: flex items-center justify-between px-4 gap-6
150150
- Description in `text-xl` to `text-3xl`, muted color, leading-tight
151151
- Command box: dark elevated surface with mono text + copy button
152152
```
153-
$ npx skillx search "deploy to cloudflare"
153+
$ npx skillx-sh search "deploy to cloudflare"
154154
```
155155
- Stats row: total skills count, total installs, agents supported
156156

@@ -169,7 +169,7 @@ Content:
169169
- **Description:** 2 lines max, truncated with ellipsis
170170
- **Tags:** Pill badges with category colors (phase-based)
171171
- **Footer row:** Install count + rating (S/A/B/C tier) + compatibility icons
172-
- **Action:** "Install" button or `npx skillx use <name>` copyable
172+
- **Action:** "Install" button or `npx skillx-sh use <name>` copyable
173173

174174
### Leaderboard Table (from skills.sh)
175175

docs/system-architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,7 @@ Session Cookie Details:
230230
### API Key Authentication
231231

232232
```
233-
CLI: npx skillx search --api-key sk_prod_abc...
233+
CLI: skillx search --api-key sk_prod_abc...
234234
235235
Request:
236236
Authorization: Bearer sk_prod_abc...

0 commit comments

Comments
 (0)