WebStray CLI

Unified command-line interface for WebStray products. Instant. Interactive. Scriptable. Powered by Node.js.

About

WebStray CLI is the official command-line interface for the WebStray ecosystem. Designed for developers and power users who prioritize speed, keyboard-centric workflows, and automation.

Documentation

Detailed documentation for WebStray CLI is available on the official WebStray website.

Key Features

• Command-Driven Navigation: Built on commander.js, providing an industry-standard syntax for subcommands, flags, and automated help generation.
• Interactive Prompts: Enhanced user experience powered by @clack/prompts for elegant terminal inputs, selections, and progress indicators.
• Optimized Performance: Minimal cold-start latency, ensuring the CLI feels snappy and responsive.
• Headless Integration: Designed to be easily wrapped into bash/zsh scripts or integrated into CI/CD pipelines.
• Visual Feedback: High-contrast, colorized output using picocolors for clear distinction between logs, warnings, and data.
• Formatted Data: Clean structured layouts for maximum readability in any terminal emulator.

Built With

WebStray CLI leverages a lightweight, modern stack focused on speed and reliability:

• commander.js – Powerful and intuitive framework for creating command-line interfaces.
• @clack/prompts – Modern, interactive prompts for building elegant command-line workflows.
• picocolors – Ultra-lightweight library for high-contrast and colorized terminal output.
• axios – Promise-based HTTP client for the browser and Node.js.
• fs-extra – Enhanced file system operations with built-in promise support and recursive actions.
• esbuild – An extremely fast JavaScript and CSS bundler and minifier.

Installation

Desktop Application

You can download the Windows installer or standalone binaries for all platforms from the official download page.

Manual Build

Clone the repository

git clone https://github.com/webstraycom/cli.git
cd cli

Install dependencies

npm install

Build standalone binaries

npm run build

Make it global

After the build, find your platform-specific binary in the ./build directory. To use the webstray command from any terminal:

Windows:

1. Rename webstray-cli-windows-x64.exe to webstray.exe.
2. Move it to a folder (e.g., C:\bin).
3. Add that folder to your System PATH environment variable.

macOS / Linux:

1. Make the binary executable.
2. Move it to /usr/local/bin and rename it to webstray.

To do this, run the following commands:

# macOS (Apple Silicon)
chmod +x ./build/webstray-cli-macos-arm64
sudo mv ./build/webstray-cli-macos-arm64 /usr/local/bin/webstray

# macOS (Intel)
chmod +x ./build/webstray-cli-macos-x64
sudo mv ./build/webstray-cli-macos-x64 /usr/local/bin/webstray

# Linux
chmod +x ./build/webstray-cli-linux-x64
sudo mv ./build/webstray-cli-linux-x64 /usr/local/bin/webstray

Please note: Since the binary is manually built and not signed, macOS may block it. To allow execution, run xattr -d com.apple.quarantine /usr/local/bin/webstray.

Done!

You've successfully installed WebStray CLI on your PC. You can now use the webstray command from any terminal window.

Quick Start

Verify the installation by running:

webstray help

Authenticator CLI

Manage and create plugins for the WebStray Authenticator desktop app:

# Interactively add new plugins
webstray authenticator add

# Generate a new plugin template
webstray authenticator create

Learn more about WebStray Authenticator CLI

Starlight CLI

Generate and download repository preview images using WebStray Starlight API:

# Download a preview for a specific repository
webstray starlight get webstraycom cli

Learn more about WebStray Starlight CLI

License

This project is licensed under the MIT License. See the LICENSE file for details.