ShellBase Documentation
ShellBase is a web app for storing, organizing, and sharing code snippets. Use folders, tags, and collections to keep your work tidy, and share anything with a single link.
Getting Started
New to ShellBase? Start here:
- Quickstart — Sign up and create your first snippet in under 5 minutes.
Getting Started
New to ShellBase? Start with these:
- Sign Up & Login — Register, verify your email, and choose a plan.
- Creating Your First Snippet — Step-by-step tutorial: create, edit, and publish a snippet.
- Import & Export — Migrate from GitHub Gists or export your ShellBase data.
Core Concepts
- Gists 101 — Understanding gists: what they are, why they matter, and how ShellBase improves on the concept.
Snippets
Learn how to create and manage your code snippets:
- Creating Snippets — Using the editor, syntax highlighting, and file attachments.
- Supported Languages — Full list of syntax-highlighted languages.
- Editing & Versioning — Diff view, restoring past versions, and edit timestamps.
- Secret vs Public Snippets — The difference between public, secret, and private snippets.
- Forking Snippets — Fork, remix, and attribute someone else's snippet.
Organization
Keep your snippets organized and discoverable:
- Folders — Create nested folders and organize snippets.
- Tags — Tag strategy, bulk editing, and filtering by tag.
- Collections — Hand-picked, orderable sets of snippets you can publish or share as a single link.
- Search & Filter — Full-text search, filter by tag, language, date, and visibility.
- Starred Snippets — Mark favorites and pin snippets to the top of your dashboard.
Sharing & Collaboration
- Sharing Links — Permalink generation, embeds, and iframe options.
- Comments & Reactions — Threaded comments and emoji reactions on shared snippets.
- Embedding — Embed a snippet in Notion, documentation sites, or any webpage.
- Access Control — Read-only share links, expiry dates, and password protection.
- Teams — Invite members, assign roles, and manage org-level billing. (B2B plans only)
- Audit Log — Full activity log with event exports. (B2B plans only)
Account & Billing
- Plans & Pricing — Free vs Pro feature comparison and limits.
- Managing Your Account — Update your profile, email address, and password.
- Billing & Invoices — Manage your subscription, update payment methods, and download receipts.
- Deleting Your Account — How to export your data and permanently remove your account.
API Reference
Planned for a future release — scope and endpoints subject to change.
- API Overview — REST architecture, authentication, and rate limits.
- Snippets API — CRUD endpoints for snippets.
- Folders & Tags API — Endpoints for managing organizational structure.
- Users API — Profile and API key management.
- Webhooks — Event types, payload schemas, and retry behavior.