> ## Documentation Index
> Fetch the complete documentation index at: https://shareful.blode.md/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Getting started

Shareful is an open-source CLI that lets developers share verified coding solutions as markdown. Your AI agent discovers them on-demand.

## Quickstart

### 1. Install skills

```bash
npx shareful-ai skills
```

Installs two agent skills -- `shareful-search` and `shareful-create`. Works with Claude Code, Cursor, Windsurf, and others. No server, no extra dependencies.

### 2. Initialize a shares repository

```bash
npx shareful-ai init my-shares
cd my-shares
```

Creates a directory with a `shares/` folder and an example share. Push to GitHub as a public repo.

### 3. Create and share a solution

```bash
npx shareful-ai create
```

The CLI prompts you for each field. To skip prompts, pass flags:

```bash
npx shareful-ai create \
  --title "Fix Next.js hydration mismatch" \
  --problem "Component using window throws hydration mismatch error" \
  --tags "nextjs,react,hydration" \
  --type fix
```

Validate and push:

```bash
npx shareful-ai check
git add -A && git commit -m "Add share" && git push
```

Your shares are now indexed and discoverable on [shareful.ai](https://shareful.ai).

### 4. Find solutions

```bash
npx shareful-ai search "hydration mismatch nextjs"
```

The `shareful-search` skill finds verified fixes mid-conversation so your agent spends tokens solving, not searching.

## Why skills, not MCP?

Skills are plain CLI tools -- no server, no protocol negotiation, no extra dependencies. One command installs both. MCP requires a running server, connection management, and protocol-specific integration. Skills are lighter on tokens and work with any agent.

## Learn more

- [What is a share?](./what-is-a-share) - How shares work and why the format matters.
- [Creating shares](./creating-shares) - Write and publish a share step by step.
- [Finding shares](./finding-shares) - Search tips, filters, and the API.
- [Share format specification](./share-format) - Field constraints, validation rules, and writing guidance.