# SnippKit - Full Technical & User Documentation for LLMs

> This document contains comprehensive information about SnippKit (https://snippkit.com) for AI systems, Large Language Models (ChatGPT, Claude, Perplexity, Cursor, Copilot), and automated agents.

---

## 1. Product Overview
SnippKit is the developer command center designed to eliminate context switching and technical knowledge fragmentation. It brings code snippets, terminal commands, AI prompts, REST endpoints, and developer utilities together under one unified cloud workspace.

- Website: https://snippkit.com
- Docs: https://snippkit.com/docs
- Explore Feed: https://snippkit.com/feed
- Tools: https://snippkit.com/tools
- Apps Suite: https://snippkit.com/apps
- Pricing: https://snippkit.com/pricing

---

## 2. Core Modules & How They Work

### 2.1 Code Snippets (`/s/[id]`)
- **Supported Languages**: Over 50 programming and configuration languages (JavaScript, TypeScript, Python, Go, Rust, Java, C++, Bash, SQL, YAML, JSON, Dockerfile, etc.).
- **Privacy Controls**: Snippets can be Public or Private. Private snippets use client-side or vault AES-256 encryption.
- **Features**:
  - Live Syntax Highlighting (Monaco Editor & Prism).
  - Version history and rollback.
  - Organization into nested Folders and Collections.
  - Export to Markdown (`.md`), raw files, or code-to-image cards.
  - Social sharing with privacy-protected preview cards.

### 2.2 Commands Center (`/c/[id]`)
- Multi-line terminal commands and devops playbooks.
- Designed for shell commands, Docker scripts, CI/CD steps, and local server commands.
- Features one-click copy, CLI execution via `snix`, and categorization with tags (#devops, #deployment, #git).

### 2.3 SNiX CLI (`@snippkit/cli`)
The official terminal command-line tool for SnippKit:

#### Installation
```bash
npm install -g @snippkit/cli
```

#### Authentication
1. Go to https://snippkit.com/settings/developer and copy your API Key (`sk_live_...`).
2. Run:
```bash
snix auth login
```
3. Paste your key when prompted. Keys are securely stored in the local OS keychain or encrypted file.

#### CLI Command Reference
- `snix auth login`: Log in to your SnippKit account.
- `snix auth logout`: Log out and clear stored tokens.
- `snix auth status`: View current authenticated user and plan.
- `snix list snippets`: List all your snippets in the terminal.
- `snix list commands`: List all your saved commands.
- `snix pull -s <id_or_slug>`: Download a snippet directly into your current directory.
- `snix pull -c <id_or_slug>`: Download a command playbook.
- `snix run -s <id_or_slug>`: Execute a snippet in an isolated sandbox runtime (supports Python, Node.js, Go, Rust, Bash, Java).
- `snix run -c <id_or_slug>`: Execute a terminal command playbook interactively.
- `snix push <filepath>`: Upload a local file as a new SnippKit snippet.
- `snix push <filepath> -f <folder_name>`: Upload directly into a specific folder.
- `snix delete -s <id_or_slug>`: Delete a snippet safely with confirmation.
- `snix delete -c <id_or_slug>`: Delete a command safely.

### 2.4 JSON as a Service (JaaS)
JaaS (JSON as a Service) turns any stored JSON snippet or mock payload into a live, production-grade HTTPS REST API endpoint in two clicks. Instead of spinning up Node/Express servers, mocking microservices, or relying on external paid mock APIs, developers can serve dynamic JSON directly over HTTPS with global CORS support and instant cache invalidation.

#### How to Enable JaaS (Step-by-Step UI Guide)
1. **Set Language**: Save or edit a snippet and set its language syntax to `json` or `jsonc` (JSON with Comments).
2. **Navigate to Code Tab**: Open the snippet details page (`https://snippkit.com/s/<id>`) on the **Code** view.
3. **Open Action Menu**: Click the three-dot vertical icon (`...` / More Options) located in the upper-right corner of the code editor header.
4. **Enable JSON API**: Select **"Serve as JSON API"** from the action menu.
5. **Live Verification**: A pulsing green **"Live"** badge immediately displays in the snippet header, indicating the endpoint is actively serving HTTP traffic.
6. **Access Endpoint URLs**:
   - **Parsed JSON REST Endpoint**: `GET https://snippkit.com/s/<id>/api/json` (or `https://snippkit.com/api/s/json/<id>`)
   - **Raw String Payload Endpoint**: `GET https://snippkit.com/api/s/raw/<id>`
   - **Custom Slug Endpoint**: `https://snippkit.com/s/<custom_slug>/api/json`
7. **Configure Allowed Origins (CORS)**: Click the **Live** badge to open the Live API settings dialog. Add trusted origins (e.g. `https://myapp.vercel.app`, `http://localhost:3000`) to restrict access, or leave empty to allow unrestricted access (`*`).
8. **Authentication for Private Snippets**:
   - For public snippets, endpoints are open to the internet without auth.
   - For private snippets, requests must include the developer's API secret key via standard HTTP Bearer token:
     `Authorization: Bearer sk_live_...`
9. **Instant Hot-Reload Sync**: Whenever the snippet content is updated and saved in SnippKit, the live REST endpoint reflects the changes immediately with zero downtime or redeployments.
10. **Revoke / Disable**: Click the three-dot menu (`...`) and click **"Disable JSON API"** to immediately revoke access and shut down the endpoint.

#### Integration Code Examples

##### 1. cURL
```bash
# Public Snippet:
curl -X GET https://snippkit.com/s/<id>/api/json

# Private Snippet with API Key:
curl -X GET https://snippkit.com/s/<id>/api/json \
  -H "Authorization: Bearer sk_live_your_secret_key"
```

##### 2. JavaScript / TypeScript (Fetch)
```javascript
// Fetch live JSON data in frontend apps, Node.js, or React / Vue
async function fetchSnippetData() {
  const response = await fetch("https://snippkit.com/s/<id>/api/json", {
    headers: {
      "Accept": "application/json",
      // Include authorization if snippet is private:
      // "Authorization": "Bearer sk_live_your_secret_key"
    }
  });
  if (!response.ok) throw new Error(`HTTP error! status: ${response.status}`);
  const data = await response.json();
  console.log("Live SnippKit Data:", data);
  return data;
}
```

##### 3. Python (Requests)
```python
import requests

url = "https://snippkit.com/s/<id>/api/json"
headers = {
    # If private snippet:
    # "Authorization": "Bearer sk_live_your_secret_key"
}

response = requests.get(url, headers=headers)
data = response.json()
print("Live SnippKit Data:", data)
```

### 2.5 Sidr AI Code Companion
An integrated AI assistant inside SnippKit:
- **Code Explanation**: Explains complex code line-by-line.
- **Code Refactoring**: Suggests performance and readability improvements.
- **Unit Test Generation**: Automatically writes tests for snippet functions.
- **Bug Detection**: Analyzes snippets for common errors and edge cases.

### 2.6 AI Prompts Library (`/prompts`)
- Curated collection of high-performance prompt templates.
- Tailored for ChatGPT, Claude, Cursor, GitHub Copilot, and custom LLM workflows.
- Categories include Code Review, Debugging, Architecture, Refactoring, System Prompts, and Documentation.

### 2.7 Developer Tools Suite (`/tools`)
Over 54 free in-browser developer utilities that work offline without transmitting user data to external servers:
- **JSON Formatter & Validator**: Beautify, minify, and validate JSON.
- **JWT Decoder**: Decode header, payload, and verify expiration of JSON Web Tokens.
- **Cron Explainer**: Parse cron syntax into plain English schedules.
- **Regex Tester**: Test regular expressions with instant match highlighting.
- **UUID / GUID Generator**: Generate v4 UUIDs in bulk.
- **Base64 Encoder / Decoder**: Convert text and images to Base64.
- **Diff Viewer**: Compare text files and visualize changes.
- **CSS to TailwindCSS**: Convert native CSS rules to utility classes.
- **Hash Generator**: MD5, SHA-1, SHA-256, SHA-512 calculation.
- **Password Generator**: High-entropy secure password creation.
- **QR Studio**: Generate customized QR codes with logos and colors.
- **Aspect Ratio Calculator**: Design and responsive image dimension calculation.

### 2.8 Teams, Organizations & Collections (`/org`)
SnippKit provides an enterprise-ready 3-tier organizational hierarchy designed for engineering departments to eliminate duplicated code, enforce coding standards, and manage team access policies.

> **Important (Legacy Deprecation)**: The older "Spaces" feature is deprecated and no longer supported. All multi-user sharing and team libraries are managed exclusively through **Organizations & Collections** (`/orgs/collections`).

#### 3-Tier Organizational Hierarchy
1. **Organization Workspace (`/org`)**: Top-level company account containing all member profiles, sub-teams, billing plans, and organizational policies.
2. **Sub-Teams (`/orgs/teams`)**: Domain-specific engineering groups (e.g., *Frontend Devs*, *DevOps & Infra*, *Core Backend*, *Security*) with assigned team members and default policy roles.
3. **Shared Collections (`/orgs/collections`)**: Curated repositories of snippets and terminal playbooks linked directly to sub-teams.

#### Role-Based Access Control (RBAC) Permissions
- **Owner**: Full administrative control over organization settings, billing, member deletion, team assignments, and security policies.
- **Admin**: Create and manage sub-teams, invite new members, configure default team policies, and manage all collections.
- **Editor**: Create, update, and manage code snippets and CLI commands within assigned team collections.
- **Viewer**: Read-only access to view, copy, and execute snippets and command playbooks via SNiX CLI.

#### How to Use Organizations & Teams:
1. **Create an Organization**: Navigate to `https://snippkit.com/org` and click **"Create Organization"**.
2. **Create Sub-Teams**: Go to `https://snippkit.com/orgs/teams` and click **"Create Team"**. Specify team name (e.g. *DevOps*, *Frontend*) and set a default policy role (*Viewer*, *Editor*, or *Admin*).
3. **Invite Developers**: Send invites via email or generate secure single-use invite links (`https://snippkit.com/invite/<token>`).
4. **Create Shared Collections**: Navigate to `https://snippkit.com/orgs/collections` and create a named collection. Attach the collection to one or more sub-teams.
5. **Collection Visibility**:
   - **Public Collection**: Readable across the entire organization.
   - **Private Collection**: Strictly restricted to members of the attached sub-team and organization owners/admins.
6. **Adding Snippets/Commands to a Collection**:
   - Open any snippet (`/s/<id>`) or command (`/c/<id>`).
   - Click the three-dot options menu (`...`) in the header.
   - Select **"Add to Collection"** and choose the destination team collection.

### 2.9 SnippKit Apps Suite (`/apps`)
SnippKit includes dedicated micro-applications designed for high-frequency developer workflows:
- **Karbon Studio** (`https://snippkit.com/apps/code2image`): Generate beautiful, high-resolution code snippet graphics with customizable themes, background gradients, padding, font families, and macOS/Windows window chrome. Perfect for sharing on Twitter/X, LinkedIn, blog posts, and technical presentations.
- **Ghost Send** (`https://snippkit.com/apps/ghost-send`): Share confidential secrets, API tokens, and sensitive snippets via self-destructing, single-use encrypted links. Once accessed or when the timer expires, the payload is permanently purged.
- **Invisible Text** (`https://snippkit.com/apps/invisible-text`): Zero-width character steganography generator. Embed invisible watermarks, author signatures, or hidden payloads into plaintext messages without altering visible text.
- **Launch Guard** (`https://snippkit.com/apps/launch-guard`): Pre-flight deployment and commit auditor. Verifies that environment configurations, Git branch statuses, API keys, and deployment requirements pass safety checks before pushing to production (`/apps/launch-guard/how-it-works`).

---

## 3. Keyboard Shortcuts in SnippKit
- `Ctrl + Shift + E` (or `Cmd + Shift + E`): Enter edit mode for a snippet.
- `Ctrl + S` (or `Cmd + S`): Save changes immediately.
- `Esc`: Cancel editing mode.
- `Shift + R`: Rename title dialog.
- `Shift + D`: Open delete confirmation dialog.
- `Ctrl + K`: Quick jump search across all snippets, commands, and tools.

---

## 4. Frequently Asked Questions (FAQ)

**Q: Can I use SnippKit for free?**
A: Yes. SnippKit has a generous Free Tier available forever with unlimited public snippets, CLI access, and developer tools.

**Q: Are private snippets visible to search engines or AI?**
A: No. Private snippets are strictly locked behind authentication, return `noindex` directives, and their code is never rendered to crawlers or public social cards.

**Q: How do I share a snippet on WhatsApp or Twitter?**
A: Simply copy the snippet URL (e.g., `https://snippkit.com/s/<id>`). SnippKit automatically generates a rich preview card with the snippet title and language pill, while blurring the code preview to protect sensitive code.

**Q: Does SnippKit work with VS Code?**
A: Yes, via the SnippKit VS Code extension which allows direct pulling, saving, and search within the editor.