# SnippKit

> SnippKit is the developer command center for capturing, organizing, executing, and sharing code snippets, terminal automations, and AI prompts with instant JSON-ready APIs and 54+ developer tools.

Website: https://snippkit.com
Documentation: https://snippkit.com/docs
CLI: https://snippkit.com/docs/cli
Full LLM Documentation: https://snippkit.com/llms-full.txt

---

## What is SnippKit?
SnippKit solves developer fragmentation by centralizing:
1. **Code Snippets**: Save, tag, syntax-highlight, version, and share code across 50+ languages.
2. **Terminal Commands**: Multi-step CLI playbooks and automation scripts executed directly in the terminal.
3. **SNiX CLI (`snix`)**: The official CLI tool (`@snippkit/cli`) to pull, run, and push code directly from your terminal session.
4. **JSON as a Service (JaaS)**: Turn any code snippet or configuration into a live hosted REST API endpoint without spinning up a server.
5. **AI Prompts Library**: Curated, reusable prompt templates for ChatGPT, Claude, Cursor, and Copilot.
6. **Sidr AI**: Built-in AI code companion for explaining, refactoring, and debugging snippets.
7. **54+ Free Developer Tools**: Free online utilities including JSON Formatter, JWT Decoder, Cron Explainer, Regex Tester, UUID Generator, and Base64 Converter.
8. **Apps Suite (`/apps`)**: Standalone developer micro-apps including Karbon Studio (`/apps/code2image`), Ghost Send (`/apps/ghost-send`), Invisible Text (`/apps/invisible-text`), and Launch Guard (`/apps/launch-guard`).
9. **Organizations, Teams & Collections (`/org`)**: Multi-user collaboration with a 3-tier hierarchy (Organizations -> Sub-Teams -> Collections) and RBAC permissions. (Note: Legacy "Spaces" is deprecated and replaced by Collections).

---

## SNiX CLI Quick Guide

### Installation
```bash
npm install -g @snippkit/cli
```
Verify installation:
```bash
snix --version
```

### Authentication
Authenticate with your secret API key (`sk_live_...`) generated in Developer Settings:
```bash
snix auth login
```
Check login status:
```bash
snix auth status
```

### Pulling & Running Code
- **Pull a snippet to local disk**:
  ```bash
  snix pull -s <snippet_id_or_slug>
  ```
- **Execute a snippet directly**:
  ```bash
  snix run -s <snippet_id_or_slug>
  ```
- **Pull and run a terminal command playbook**:
  ```bash
  snix run -c <command_id_or_slug>
  ```
- **Upload local file to SnippKit**:
  ```bash
  snix push ./my-script.py
  ```

---

## JSON as a Service (JaaS)
Turn any saved JSON snippet or mock payload into a live, production-grade HTTPS REST API endpoint in two clicks—without setting up custom servers or mock infrastructure.

### How to Enable JaaS on Any Snippet:
1. **Language Requirement**: Set the snippet language to `json` or `jsonc` (JSON with Comments).
2. **Open Snippet**: Navigate to the snippet details page (`https://snippkit.com/s/<id>`) on the **Code** tab.
3. **Open Action Menu**: Click the three-dot menu icon (`...` / More Options) in the top-right corner of the editor header.
4. **Activate Endpoint**: Select **"Serve as JSON API"** from the dropdown menu.
5. **Live Status**: A pulsing green **"Live"** badge immediately appears in the snippet header, confirming the REST endpoint is online.
6. **Access Endpoint URLs**:
   - **Parsed JSON REST API**: `GET https://snippkit.com/s/<id>/api/json` (or `https://snippkit.com/api/s/json/<id>`)
   - **Raw Code Endpoint**: `GET https://snippkit.com/api/s/raw/<id>`
   - Custom slug endpoints are also supported: `https://snippkit.com/s/<custom-slug>/api/json`
7. **CORS & Domain Allowlisting**: In the Live API settings dialog, add authorized client domains (e.g. `https://your-domain.com`) to restrict cross-origin browser requests, or leave open for unrestricted public access.
8. **Authentication for Private Snippets**:
   - **Public snippets**: Publicly accessible with global CORS—ideal for frontend prototypes, mobile apps, and open APIs.
   - **Private snippets**: Require an API key in the request header:
     `Authorization: Bearer sk_live_your_secret_key`
9. **Instant Hot-Reload Sync**: Any changes saved to the JSON snippet immediately update the live REST endpoint response without server restarts.
10. **Disable / Revoke**: Click the three-dot menu (`...`) and select **"Disable JSON API"** at any time to take the endpoint offline.

### Quick Request Examples:
```bash
# Fetch live public JSON data
curl https://snippkit.com/s/<snippet_id>/api/json

# Fetch private JSON snippet with bearer token
curl -H "Authorization: Bearer sk_live_your_secret_key" https://snippkit.com/s/<snippet_id>/api/json
```

---

## Documentation Index

- [Introduction & Workspace Setup](https://snippkit.com/docs/introduction): Getting started with personal and team workspaces.
- [Quick Start Guide](https://snippkit.com/docs/quick-start): Creating your first snippet, command, and prompt in 2 minutes.
- [SNiX CLI Reference](https://snippkit.com/docs/cli): Complete manual for `@snippkit/cli`, command actions, and flags.
- [Code Snippets Management](https://snippkit.com/docs/snippets): Organization, Markdown export, version history, and tags.
- [Commands Center](https://snippkit.com/docs/commands-center): Building multi-command deployment and devops workflows.
- [JaaS (JSON as a Service)](https://snippkit.com/docs/json): Creating hosted REST APIs from snippets.
- [Sidr AI Assistant](https://snippkit.com/docs/services/sidr-ai): Using the built-in AI code companion.
- [AI Prompts Library](https://snippkit.com/docs/ai-prompts): Searching, starring, and using curated developer prompts.
- [Developer Tools Overview](https://snippkit.com/docs/tools-overview): Complete guide to all 54 in-browser developer utilities.
- [Apps Suite & Micro-Apps](https://snippkit.com/apps): Standalone developer apps (Karbon Studio, Ghost Send, Invisible Text, Launch Guard).
- [Karbon Studio (Code2Image)](https://snippkit.com/apps/code2image): Export beautiful, syntax-highlighted code images for socials.
- [Ghost Send](https://snippkit.com/apps/ghost-send): Zero-knowledge, self-destructing one-time secrets and secure links.
- [Invisible Text](https://snippkit.com/apps/invisible-text): Zero-width steganography to conceal metadata inside text.
- [Launch Guard](https://snippkit.com/apps/launch-guard): Pre-deployment environment audit and pre-push safety checklist.
- [VS Code Extension](https://snippkit.com/docs/extension/vscode): Managing SnippKit directly from VS Code.
- [Organizations & Teams Overview](https://snippkit.com/docs/org): 3-tier hierarchy (Org -> Sub-Teams -> Collections) and access controls (legacy Spaces is deprecated).
- [Teams & Policy Management](https://snippkit.com/docs/orgs/teams): Managing sub-teams and RBAC roles (Owner, Admin, Editor, Viewer).
- [Shared Collections & Access](https://snippkit.com/docs/orgs/collections): Grouping snippets and commands into access-controlled repositories with Public/Private visibility.
- [Security & AES-256 Vault](https://snippkit.com/docs/settings/security): End-to-end encryption for private snippets and API keys.
- [Pricing & Plans](https://snippkit.com/pricing): Free tier details vs Pro and Enterprise.