iobend

v2.6.4

Published

a month ago

Command-line interface for the IOBend Unified Developer Experience Platform

0High
0Medium
0Low

iobend

iobenddev

cli developer-experience unified-platform developer automation setup

IOBend CLI is the command-line interface for the IOBend Unified Developer Experience Platform. It acts as an ultra-fast orchestrator across your native OS package managers (winget, brew, apt, dnf, pacman), secret workflows, diagnostic tools, and project workspaces, connecting seamlessly with IOBend Web and IDE extensions.

Say goodbye to "it works on my machine." With IOBend CLI, you can define, verify, diagnose, and run your project environments with zero friction.

🚀 Installation

1. Homebrew Tap (macOS & Linux) — Official Live Tap

brew tap Iobend/tap
brew install iobend

2. Windows WinGet — Native Live Installer

winget install iobend

3. NPM Global Package

npm install -g iobend

4. Standalone Binary (Zero-Dependency)

IOBend can be compiled into a zero-dependency standalone executable (iobend.exe / iobend) that doesn't require Node.js to be installed on your machine.

npm run build

5. 1-Click Shell Auto-Completion Setup

Enable tab completion in your terminal for commands, subcommands, tools, and flags:

# Auto-detect active shell and install completion script:
iobend completion --install

# Explicitly install for PowerShell (Windows):
iobend completion -s powershell --install

# Explicitly install for Zsh (macOS/Linux):
iobend completion -s zsh --install

Supported shells: bash, zsh, powershell (pwsh), fish.

🛠️ Core Workflow: Project Environments

IOBend truly shines when used to manage project-specific environments using an iobend.yaml file.

1. Initialize a Project

You can set up a project in two ways depending on your workflow:

Option A: `iobend init` (Existing Directory)

Run iobend init inside an existing project folder. It quickly scaffolds .iobend/project.json locally.

iobend init

Option B: `iobend project create` (New Project / Cloud-Linked)

Run iobend project create to scaffold a new project with options to create a subfolder and immediately create/link it to your IOBend Cloud Workspace.

iobend project create

🔍 `iobend init` vs `iobend project create`: When should you use which?

💡 When should you use which?
Use iobend init when you have already cloned/opened an existing repository and want to enable IOBend doctor, secrets, and environment tracking locally without creating a cloud project right away.
Use iobend project create when starting a new project (scaffolding a new directory) or when you want the project immediately created in your IOBend Cloud dashboard.

2. Verify and Auto-Fix

Once your iobend.yaml is generated, anyone who clones your repository can instantly verify if their machine has the required tools installed by running:

iobend doctor

If they are missing tools, they can instruct IOBend to automatically download and install all missing dependencies natively using their OS package manager!

iobend doctor --fix

📚 Command Reference & Flags

🔐 Authentication Commands

(Note: These are grouped under iobend auth, but top-level aliases are available for backward compatibility)

📂 Projects & Init Commands

🔑 Secrets Commands

📦 Assets & Deps Commands

💾 Backups Commands

🔄 Device & Sync Commands

🏪 Marketplace & Package Registry Commands

🐳 Containers & Local Database Commands

🤖 AI & Model Context Protocol (MCP) Commands

🚀 Execution & Workflow Commands

🛠️ Utilities Commands

🔄 Local-to-Cloud Syncing (`iobend sync`)

The CLI acts as the local source of truth. Running iobend sync will scan the local project context, collect details, and present a preview:

────────────────────────────────────────
Project         my-app
Secrets         12
Assets          5
Dependencies    48
Configuration   package.json, docker-compose.yml
Health          Healthy
────────────────────────────────────────

You will be prompted to approve the upload:

Upload selected data to IOBend Cloud? [Y/n]

Flags:

--dry-run: Generates the sync preview payload locally without performing any remote API calls.
--force: Skips uploading unchanged items, updating only modified settings.

🏥 Diagnostics (`iobend doctor`)

The doctor command runs cross-platform system sweeps verifying your runtime environments. It evaluates:

Operating System details
Disk Space & Memory (RAM) usage
Internet Connection status
Compilers & Toolchains: Node.js, npm, pnpm, yarn, Git, Docker, Python, Java, Go, Rust.

🧹 Storage & Cache Diagnostics (`iobend doctor storage`)

Calculates exact disk consumption across Recycle Bin/Trash, package manager caches, and system temporary files:

# Run storage and cache audit
iobend doctor storage

# Output machine-readable JSON format
iobend doctor storage --json

# Safely purge temporary caches and empty Recycle Bin
iobend doctor storage --clean

Audited targets include:

Recycle Bin / OS Trash (C:\$Recycle.Bin, ~/.Trash)
NPM Cache (npm-cache)
PNPM Store (pnpm/store)
Yarn Cache (Yarn/Cache)
Bun Cache (.bun/install/cache)
Python Pip Cache (pip/cache)
Go Build Cache (go-build)
Rust / Cargo Cache (.cargo/registry/cache)
Gradle & Maven Caches (.gradle/caches, .m2/repository)
IOBend Runtimes & Logs (.iobend/runtimes, .iobend/logs)
User Temp & Crash Dumps (AppData/Local/Temp, AppData/Local/CrashDumps)

🏗️ Architecture & Extensibility

IOBend is built on a feature-first clean architecture pattern:

src/commands/: Isolated logic for every CLI command.
src/checks/: Independent, modular validation checks that power the doctor command.
src/installers/: The true muscle of IOBend. A smart, platform-aware translation engine that automatically detects your OS and proxies commands to the correct native package manager (winget, brew, apt, etc.).
src/render/: A decoupled UI layer utilizing chalk and ora for a premium, perfectly aligned terminal experience.

📖 Developer Cheat Sheet & Quick Reference

📄 Download Printable Cheat Sheet (PDF)
📑 View Markdown Cheatsheet