Preflight local VyOS bundles. Release bundles with SSH. Copy router configuration and scripts with SSH.
- Features
- Requirements
- Setup
- Usage
- Development
- Testing
- Troubleshooting
- Security
- Configuration
- Operations
- Commands
- Exit codes
- Support
- Links
- License
VyOps checks local bundles before release. It can save router configuration and scripts with SSH. It can save confirmed router state to Git.
- Use Node.js 26 or later.
- Use npm 12 or later to validate this repository.
- Give the router a trusted SSH host key.
Install the public package:
npm install --global @eliware/vyopsThe vyops command runs bin/vyops.
The package includes bin/, src/, docs/, specs/, .env.example, and project records.
Only an approved release owner can publish a new package version.
Read the installation guide for package contents and release limits.
Run vyops preflight to check a local bundle. Run vyops release to send it to a router.
Run vyops backup to save the active config and scripts.
Read the usage guide, bundle guide, and specification index for details. Use the documentation index to find each user guide. Read release notes for version changes.
Use Node.js 26 or later and npm 12 or later. Read AGENTS.md and specifications before you change this repository.
Install locked dependencies:
npm ciRun aggregate validation:
npm testnpm test runs repository checks and Jest tests.
The tests mock SSH and Git commands. They do not connect to a router.
Read the troubleshooting guide for typical errors.
Use vyops --help to view command syntax.
Keep router config, backups, logs, and SSH keys private.
Do not pass a password as a command-line value.
Use --password-stdin for SSH password input.
Read the safe release guidance before a release.
Set runtime options with process environment variables.
VyOps does not load .env files.
Read the configuration guide for names and defaults.
The command starts through bin/vyops.
It closes active SSH connections before it exits.
Preflight checks local files and makes no SSH connection.
Release runs preflight before Git checks or SSH setup.
Backup reads router data and writes a local backup.
Read the preflight, release, and
backup guides before you use these commands.
| Command | Action |
|---|---|
vyops preflight <config.boot> |
Check the local config, scripts, and manifest. |
vyops release --yes <config.boot> |
Send a bundle to its configured router. |
vyops backup <user@host> <directory> |
Save router config and scripts. |
vyops --help |
Print command syntax. |
vyops --version |
Print the package version. |
Read the command guide for options and arguments.
Exit code 0 means success. Exit code 1 means an argument, validation, connection, or operation error.
For help, questions, or to chat with the author and community, visit:
