mirror of
https://github.com/runkids/skillshare.git
synced 2026-11-20 20:34:19 +00:00
196 lines
4.5 KiB
Markdown
196 lines
4.5 KiB
Markdown
---
|
|
sidebar_position: 2
|
|
---
|
|
|
|
# extras
|
|
|
|
Manage non-skill resources (rules, commands, prompts, etc.) that are synced alongside skills.
|
|
|
|
## Overview
|
|
|
|
Extras are additional resource types managed by skillshare — think of them as "skills for non-skill content." Common use cases include syncing AI rules, editor commands, or prompt templates across tools.
|
|
|
|
Each extra has:
|
|
- A **name** (e.g., `rules`, `prompts`, `commands`)
|
|
- A **source directory** under `~/.config/skillshare/<name>/` in your config directory
|
|
- One or more **targets** where files are synced to
|
|
|
|
## Commands
|
|
|
|
### `extras init`
|
|
|
|
Create a new extra resource type.
|
|
|
|
```bash
|
|
# Interactive wizard
|
|
skillshare extras init
|
|
|
|
# CLI flags
|
|
skillshare extras init <name> --target <path> [--target <path2>] [--mode <mode>]
|
|
```
|
|
|
|
**Options:**
|
|
|
|
| Flag | Description |
|
|
|------|-------------|
|
|
| `--target <path>` | Target directory path (repeatable) |
|
|
| `--mode <mode>` | Sync mode: `merge` (default), `copy`, or `symlink` |
|
|
| `--project, -p` | Create in project config (`.skillshare/`) |
|
|
| `--global, -g` | Create in global config |
|
|
|
|
**Examples:**
|
|
|
|
```bash
|
|
# Sync rules to Claude and Cursor
|
|
skillshare extras init rules --target ~/.claude/rules --target ~/.cursor/rules
|
|
|
|
# Project-scoped extra with copy mode
|
|
skillshare extras init prompts --target .claude/prompts --mode copy -p
|
|
```
|
|
|
|
### `extras list`
|
|
|
|
List all configured extras and their sync status.
|
|
|
|
```bash
|
|
skillshare extras list [--json] [-p|-g]
|
|
```
|
|
|
|
**Output columns:**
|
|
- Source directory and file count
|
|
- Per-target: path, mode, and sync status (`synced`, `drift`, `not synced`, `no source`)
|
|
|
|
**Example output:**
|
|
|
|
```
|
|
$ skillshare extras list
|
|
|
|
Rules ~/.config/skillshare/rules/ (2 files)
|
|
✔ ~/.claude/rules merge synced
|
|
✔ ~/.cursor/rules copy synced
|
|
|
|
Prompts ~/.config/skillshare/prompts/ (1 file)
|
|
✔ ~/.claude/prompts merge synced
|
|
```
|
|
|
|
### `extras remove`
|
|
|
|
Remove an extra from configuration.
|
|
|
|
```bash
|
|
skillshare extras remove <name> [--force] [-p|-g]
|
|
```
|
|
|
|
Source files and synced targets are not deleted — only the config entry is removed.
|
|
|
|
### `extras collect`
|
|
|
|
Collect local files from a target back into the extras source directory. Files are copied to source and replaced with symlinks.
|
|
|
|
```bash
|
|
skillshare extras collect <name> [--from <path>] [--dry-run] [-p|-g]
|
|
```
|
|
|
|
**Options:**
|
|
|
|
| Flag | Description |
|
|
|------|-------------|
|
|
| `--from <path>` | Target directory to collect from (required if multiple targets) |
|
|
| `--dry-run` | Show what would be collected without making changes |
|
|
|
|
**Example:**
|
|
|
|
```bash
|
|
# Collect rules from Claude back to source
|
|
skillshare extras collect rules --from ~/.claude/rules
|
|
|
|
# Preview what would be collected
|
|
skillshare extras collect rules --from ~/.claude/rules --dry-run
|
|
```
|
|
|
|
---
|
|
|
|
## Sync Modes
|
|
|
|
| Mode | Behavior |
|
|
|------|----------|
|
|
| `merge` (default) | Per-file symlinks from target to source |
|
|
| `copy` | Per-file copies |
|
|
| `symlink` | Entire directory symlink |
|
|
|
|
---
|
|
|
|
## Directory Structure
|
|
|
|
```
|
|
~/.config/skillshare/
|
|
├── config.yaml # extras config lives here
|
|
├── skills/ # skill source
|
|
└── extras/ # extras source root
|
|
├── rules/ # extras/rules/ source files
|
|
│ ├── coding.md
|
|
│ └── testing.md
|
|
└── prompts/
|
|
└── review.md
|
|
```
|
|
|
|
---
|
|
|
|
## Configuration
|
|
|
|
In `config.yaml`:
|
|
|
|
```yaml
|
|
extras:
|
|
- name: rules
|
|
targets:
|
|
- path: ~/.claude/rules
|
|
- path: ~/.cursor/rules
|
|
mode: copy
|
|
- name: prompts
|
|
targets:
|
|
- path: ~/.claude/prompts
|
|
```
|
|
|
|
---
|
|
|
|
## Syncing
|
|
|
|
Extras are synced with:
|
|
|
|
```bash
|
|
skillshare sync extras # sync extras only
|
|
skillshare sync --all # sync skills + extras together
|
|
```
|
|
|
|
See [sync extras](/docs/reference/commands/sync#sync-extras) for full sync documentation including `--json`, `--dry-run`, and `--force` options.
|
|
|
|
---
|
|
|
|
## Workflow
|
|
|
|
```bash
|
|
# 1. Create a new extra
|
|
skillshare extras init rules --target ~/.claude/rules --target ~/.cursor/rules
|
|
|
|
# 2. Add files to the source directory
|
|
# (edit ~/.config/skillshare/rules/coding.md)
|
|
|
|
# 3. Sync to targets
|
|
skillshare sync extras
|
|
|
|
# 4. List status
|
|
skillshare extras list
|
|
|
|
# 5. Collect a file edited in a target back to source
|
|
skillshare extras collect rules --from ~/.claude/rules
|
|
```
|
|
|
|
---
|
|
|
|
## See Also
|
|
|
|
- [sync](/docs/reference/commands/sync#sync-extras) — Sync extras to targets
|
|
- [status](/docs/reference/commands/status) — Show extras file and target counts
|
|
- [Configuration](/docs/reference/targets/configuration#extras) — Extras config reference
|