CLI Overview & Setup
Install, configure, and get started with the official ZyVOP command-line interface.
ZyVOP CLI Overview
The ZyVOP CLI (zyvop) is an open-source, developer-centric tool for publishing and synchronizing technical articles from your terminal. It bridges your local Markdown repository with ZyVOP and external platforms including DEV.to, Hashnode, Medium, Bluesky, and WordPress.
Installation
The ZyVOP CLI requires Node.js v20.0.0 or higher. Install zyvop globally via npm, pnpm, or yarn. Alternatively, execute commands on-the-fly with npx.
npm install -g zyvopVerify Installation
zyvop --versionOutput:
1.1.1Command Summary
| Command | Description |
|---|---|
zyvop publish <file> | Publish or cross-post a Markdown article |
zyvop login | Authenticate your CLI session via terminal prompts or credentials |
zyvop whoami | Verify active user identity and session validity |
zyvop import <source> <id> | Import published articles from DEV.to, Hashnode, or RSS |
zyvop logout | Clear local credentials and stored session tokens |
Two Operating Modes: Cloud vs Local
The ZyVOP CLI supports two distinct operational modes:
1. Cloud-Managed Mode (Default)
When you run zyvop publish post.md:
- Your post is uploaded to the ZyVOP publishing engine.
- ZyVOP triggers distribution to your connected integrations (DEV.to, Hashnode, Medium, Bluesky, WordPress) using the encrypted credentials saved in your ZyVOP dashboard.
- Analytics, cross-post links, and reading stats are automatically synced and aggregated in your ZyVOP dashboard.
2. Local-Only Mode (--local)
If you want to keep provider credentials on your machine or private CI runner instead of storing them with ZyVOP:
- Add the
--localflag:zyvop publish post.md --local - The CLI makes direct HTTPS API calls to DEV.to, Hashnode, Medium, Bluesky, and WordPress using local environment variables (
ZYVOP_DEVTO_API_KEY, etc.). - See Local Publishing Guide for details.
Global Flags
The following flags are accepted across commands:
-v, --version: Output the current version of the CLI.-h, --help: Display help and command usage.--endpoint <url>: Override the default ZyVOP GraphQL/API endpoint (default:https://zyvop.com/graphql).
Pass developer tokens through ZYVOP_TOKEN or the restricted local configuration file. Avoid command-line token arguments because process listings and shell history can expose them.