Skip to content

Getting started

@zyno-io/zynohosting provides two executables:

  • zynohosting for people and CI jobs;
  • zynohosting-mcp for local stdio MCP clients.

Both clients use the same Hosting Manager API, permission model, and short-lived site capabilities.

Requirements

  • Node.js 24
  • a Zyno account or tenant API key
  • access to at least one ZynoHosting site

Install the CLI

Install it globally when you use it regularly:

bash
npm install --global @zyno-io/zynohosting
zynohosting --version

Or run the published package without a global install:

bash
npx -y @zyno-io/zynohosting sites list

Sign in

Interactive users can sign in through Zyno:

bash
zynohosting login

CI jobs should inject a tenant API key rather than save a browser session:

bash
export ZYNO_HOSTING_API_KEY='your-tenant-api-key'

See Authentication for credential precedence, environments, and non-interactive setup.

Confirm site access

List the sites granted to the current tenant credential:

bash
zynohosting sites list

Then inspect one site by UUID or hostname:

bash
zynohosting sites get example.com

Choose a workflow

Work with individual files

bash
zynohosting files list example.com
zynohosting files get example.com index.html --output ./index.html

Continue with Individual files.

Deploy a directory

Always preview the exact synchronization plan first:

bash
zynohosting deploy example.com ./dist --dry-run
zynohosting deploy example.com ./dist

Continue with Full deployments.

Connect an agent

Run the local MCP server with at least one allowed filesystem root:

bash
npx -y @zyno-io/zynohosting mcp --root /absolute/path/to/project

Continue with Configure MCP.

Global options

These options apply to the CLI and may be placed before a command:

OptionPurpose
-V, --versionPrint the installed package version.
--api-url <url>Override the Hosting Manager API URL.
--environment <name>Select production, alpha, or dev.
--api-key <key>Supply a tenant API key. Prefer the environment variable in automation.
--jsonEmit machine-readable output where the command supports it.

TIP

Run zynohosting <command> --help to see command-specific options for the installed release.

Next steps

Documentation for the ZynoHosting CLI and local MCP server.