docs.slopdrop.dev / slopdrop / guides / getting-started.md
Raw

Getting Started with SlopDrop

Install

# macOS (Homebrew)
brew install slopdrop/tap/slop

# Or build from source
git clone https://github.com/slopdrop/cli
cd cli && go build -o slop . && cp slop /usr/local/bin/

Authentication

slop login

This opens your browser. Pick or create a tenant (your org name), authenticate, done. Credentials stored at ~/.config/slop/credentials.json.

For CI/CD, use API tokens instead:

slop token create --name "github-actions" --expires 90d
# Save the token — it's shown once
export SLOP_TOKEN=slop_live_...

Your First Drop

# Drop a single file
slop drop ./analysis.md

# Drop to a specific path
slop drop ./analysis.md research/q1-analysis.md

# List your drops
slop list

Project Setup

Initialize a project to enable slop watch:

cd ~/my-project
slop init
# Creates .slop config file

Edit .slop to configure patterns:

tenant: acme
project: my-project
patterns:
  - "**/*.md"
ignore:
  - "node_modules/**"
  - ".git/**"

Watch Mode

Auto-sync files as they change:

# Watch current project
slop watch

# Watch all configured projects
slop watch --global

See global-watch for multi-project setup.

What Happens to Your Files

  1. File is read and checked for secrets (API keys, tokens, etc.)
  2. If clean, uploaded to your tenant's storage
  3. Versioned automatically — every change creates a new version
  4. Available at https://{tenant}.slopdrop.dev/{project}/{path}

Markdown files are rendered with syntax highlighting, table of contents, and wiki-link support.