Get Started

Scribbler CLI is a lightning-fast, terminal-based markdown environment designed for developers. Learn how to install the tool and launch your first workspace.

Installation & Initialization 

              
                $ npm install -g scribbler-cli
                $ scribbler-cli init
                
                > Initializing workspace at ~/.scribbler
                > Creating default config.yml
                > Workspace ready. Type `scribbler-cli start` to begin.

Configuration

Scribbler CLI relies on a single config.yml file located in your root directory. This file dictates encryption rules, theme preferences, and sync targets.

Property Description Default Value
local_encryption Enables AES-256 encryption for all locally stored markdown files. A master password will be required on launch. false
syntax_theme Specifies the color palette for terminal rendering. Options include monokai, dracula, or solarized. "monokai"
auto_save_interval Time in seconds between background draft saves. Set to 0 to disable auto-save entirely. 60

To view your current active configuration tree directly from the terminal, simply run scribbler-cli --config-dump.

Cloud Sync

As of v1.2, Scribbler CLI natively supports pushing your encrypted markdown notes to remote cloud storage providers, ensuring you never lose your data across different workstations.

To enable AWS S3 synchronization, you must first export your AWS credentials to your environment variables or store them in your global AWS credentials file.

Once authenticated, update your config.yml to set sync_provider: 's3' and specify your target bucket name. Syncing will occur automatically upon exiting the workspace via the Esc key.

Troubleshooting

If you encounter a "Permission Denied" error during installation on Linux or macOS, ensure you are prepending the command with sudo or have correctly configured your npm global installation path.

For webhook integration failures, verify that your target server supports SSL, as Scribbler CLI strictly enforces HTTPS for all outgoing network payloads to prevent man-in-the-middle data leaks. If problems persist, check the internal debug log located at ~/.scribbler/logs/error.log.