mirror of
https://github.com/runkids/skillshare.git
synced 2026-11-20 12:23:22 +00:00
Restructure the entire documentation site following the Diátaxis framework (Learn / How-to / Understand / Reference) with new content across 110 files. ## Information Architecture (M1) - Move all docs to Diátaxis directory structure (learn/, how-to/, understand/, reference/) - Add client-redirects plugin for old URL compatibility - Rewrite sidebar, navbar, and footer to match new IA - Update all internal cross-references ## Homepage + Quickstarts (M2) - Add scenario entry cards to homepage with hand-drawn design - 5 quickstart pages: Claude Code, GitHub Copilot (with copy mode recommendation), Codex, Multiple Tools, Dev Containers, Playground ## Blog + Changelog (M3) - Enable Docusaurus blog plugin with authors.yml - 5 blog posts: 5-min tutorial, managing 50+ skills, skillshare vs vercel/skills comparison, team sharing patterns, write your first skill - Static /changelog page from CHANGELOG.md ## Recipes + Philosophy (M4) - 5 recipe pages: CI/CD validation, enterprise skills, project setup, cross-machine sync, team onboarding - 3 philosophy pages: why-local-first, security-first, sync-modes-explained ## Content Polish - Cross-validate all content against CLI source (19 inaccuracies fixed) - Lowercase "skillshare" throughout (avoid brand conflict with Skillshare Inc.) - Add registry.yaml to file structure and Key Paths docs - Highlight multi-platform git support (GitHub, GitLab, Bitbucket, Gitea, Azure DevOps, AtomGit, Codeberg) - Standardize brew install command - Add AsciinemaPlayer component (cast recordings pending)
173 lines
4.9 KiB
Markdown
173 lines
4.9 KiB
Markdown
---
|
|
sidebar_position: 1
|
|
---
|
|
|
|
# init
|
|
|
|
First-time setup. Auto-detects installed AI CLIs and configures targets.
|
|
|
|
```bash
|
|
skillshare init # Interactive setup
|
|
skillshare init --dry-run # Preview without changes
|
|
```
|
|
|
|
## When to Use
|
|
|
|
- First time setting up skillshare on a machine
|
|
- Migrating to a new computer (with `--remote` to connect to existing repo)
|
|
- Adding skillshare to a project (with `--project`)
|
|
- Discovering newly installed AI CLIs (with `--discover`)
|
|
|
|
## What Happens
|
|
|
|
```mermaid
|
|
flowchart TD
|
|
TITLE["skillshare init"]
|
|
S1["1. Create source directory"]
|
|
S2["2. Auto-detect AI CLIs"]
|
|
S3["3. Initialize git"]
|
|
S4["4. Set up remote"]
|
|
S5["5. Create config.yaml"]
|
|
S6["6. Built-in skill"]
|
|
TITLE --> S1 --> S2 --> S3 --> S4 --> S5 --> S6
|
|
```
|
|
|
|
## Project Mode
|
|
|
|
Initialize project-level skills with `-p`:
|
|
|
|
```bash
|
|
skillshare init -p # Interactive
|
|
skillshare init -p --targets claude,cursor # Non-interactive
|
|
```
|
|
|
|
### What Happens
|
|
|
|
```mermaid
|
|
flowchart TD
|
|
TITLE["skillshare init -p"]
|
|
S1["1. Create .skillshare/ directory"]
|
|
S2["2. Detect AI CLI directories"]
|
|
S3["3. Create target skill directories"]
|
|
S4["4. Write config.yaml"]
|
|
TITLE --> S1 --> S2 --> S3 --> S4
|
|
```
|
|
|
|
After init, commit `.skillshare/` to git. See [Project Setup](/docs/how-to/sharing/project-setup) for the full guide.
|
|
|
|
## Discover Mode
|
|
|
|
Re-run init on an existing setup to detect and add new AI CLI targets:
|
|
|
|
### Global
|
|
|
|
```bash
|
|
skillshare init --discover # Interactive selection
|
|
skillshare init --discover --select codex,opencode # Non-interactive
|
|
```
|
|
|
|
Scans for newly installed AI CLIs not yet in your config and prompts you to add them.
|
|
|
|
### Project
|
|
|
|
```bash
|
|
skillshare init -p --discover # Interactive selection
|
|
skillshare init -p --discover --select gemini # Non-interactive
|
|
```
|
|
|
|
Scans the project directory for new AI CLI directories (e.g., `.gemini/`) and adds them as targets.
|
|
|
|
### Discover + Mode behavior
|
|
|
|
When you combine `--discover` with `--mode`, the mode is applied **only** to targets added in this discover run.
|
|
Existing targets in config are left unchanged.
|
|
|
|
```bash
|
|
# Adds cursor with mode=copy, does not change existing targets
|
|
skillshare init --discover --select cursor --mode copy
|
|
|
|
# Project mode variant (same rule)
|
|
skillshare init -p --discover --select cursor --mode copy
|
|
```
|
|
|
|
:::tip
|
|
If you run `skillshare init` on an already-initialized setup without `--discover`, the error message will hint you to use it.
|
|
:::
|
|
|
|
## Options
|
|
|
|
| Flag | Description |
|
|
|------|-------------|
|
|
| `--source, -s <path>` | Custom source directory |
|
|
| `--remote <url>` | Set git remote (implies `--git`; auto-pulls if remote has skills) |
|
|
| `--project, -p` | Initialize project-level skills in current directory |
|
|
| `--copy-from, -c <name\|path>` | Copy skills from a specific CLI or path |
|
|
| `--no-copy` | Start with empty source (skip copy prompt) |
|
|
| `--targets, -t <list>` | Comma-separated target names |
|
|
| `--all-targets` | Add all detected targets |
|
|
| `--no-targets` | Skip target selection |
|
|
| `--mode, -m <mode>` | Set default mode for newly configured targets (`merge`, `copy`, `symlink`). With `--discover`, affects only newly added targets. |
|
|
| `--git` | Initialize git without prompting |
|
|
| `--no-git` | Skip git initialization |
|
|
| `--skill` | Install built-in skillshare skill without prompting (adds `/skillshare` to AI CLIs) |
|
|
| `--no-skill` | Skip built-in skill installation |
|
|
| `--discover, -d` | Detect and add new AI CLI targets to existing config |
|
|
| `--select <list>` | Comma-separated targets to add (requires `--discover`) |
|
|
| `--dry-run, -n` | Preview without changes |
|
|
|
|
`init` sets your starting mode policy. You can always fine-tune per target later:
|
|
|
|
```bash
|
|
skillshare target cursor --mode copy
|
|
skillshare sync
|
|
```
|
|
|
|
## Common Scenarios
|
|
|
|
### Remote setup (pick one)
|
|
|
|
Interactive (recommended for first-time setup when you want guided prompts):
|
|
|
|
```bash
|
|
skillshare init --remote git@github.com:you/my-skills.git
|
|
```
|
|
|
|
Non-interactive (no prompts, auto-detect installed targets):
|
|
|
|
```bash
|
|
skillshare init --remote git@github.com:you/my-skills.git --no-copy --all-targets --no-skill
|
|
```
|
|
|
|
Non-interactive (no prompts, and import existing Claude skills now):
|
|
|
|
```bash
|
|
skillshare init --remote git@github.com:you/my-skills.git --copy-from claude --all-targets --no-skill
|
|
```
|
|
|
|
### Other scenarios
|
|
|
|
```bash
|
|
# Standard setup (auto-detect everything)
|
|
skillshare init
|
|
|
|
# Use existing skills directory
|
|
skillshare init --source ~/.config/skillshare/skills
|
|
|
|
# Project-level setup
|
|
skillshare init -p
|
|
skillshare init -p --targets claude,cursor
|
|
|
|
# Fully non-interactive setup
|
|
skillshare init --no-copy --all-targets --git --skill
|
|
|
|
# Start with copy mode defaults for newly added targets
|
|
skillshare init --mode copy
|
|
|
|
# Add newly installed CLIs to existing config
|
|
skillshare init --discover
|
|
skillshare init -p --discover
|
|
|
|
# Add a newly discovered target and force copy mode only for that new target
|
|
skillshare init --discover --select cursor --mode copy
|
|
```
|