PHPackages guttmann/naut-cli - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. guttmann/naut-cli ActiveProject guttmann/naut-cli ================= CLI client for SilverStripe deploynaut 4.0.0(6y ago)2252[2 PRs](https://github.com/guttmann/naut-cli/pulls)MITPHP Since Jun 1Pushed 3y ago1 watchersCompare [ Source](https://github.com/guttmann/naut-cli)[ Packagist](https://packagist.org/packages/guttmann/naut-cli)[ RSS](/packages/guttmann-naut-cli/feed)WikiDiscussions master Synced 2mo ago READMEChangelog (7)Dependencies (6)Versions (11)Used By (0) naut-cli ======== [](#naut-cli) A cli client for SilverStripe's deploynaut. Install ------- [](#install) Download the latest phar from the releases section of this repo and put it somewhere on your `$PATH`. Or you can clone this repository and build the phar yourself by following the instructions in the Build section below. Configuration ------------- [](#configuration) naut-cli can be configured in two ways. 1. By creating a `.naut.env` file in the users home directory (generated with the `naut-cli configure` command) 2. By setting the required environment variables before running any naut-cli commands ### Required environment variables [](#required-environment-variables) If you are not going to use a `.naut.env` file in your home directory, these environment variables must be set: - `NAUT_URL`: the URL of the deploynaut instances - `NAUT_USERNAME`: your deploynaut username - `NAUT_TOKEN`: your deploynaut API token Usage ----- [](#usage) There are a few different commands that can be run. ### Configure [](#configure) naut-cli can be configured by placing a `.naut.env` file in your home directory. You can create this file interactively by running: ``` php naut-cli.phar configure ``` This will ask you for: - The domain of deploynaut (e.g. ) - Your username (e.g. ) - Your deploynaut API token And create a new file at `~/.naut.env` that is only readable by the current user. ### Deploy [](#deploy) Deploy the latest commit of a project to a specific environment with deploy: ``` php naut-cli.phar deploy ``` Where: - `` is the short text identifier of the project in deploynaut (also seen in the deploynaut URL at `/naut/project/`) - `` is the name of the environment you want to deploy to (e.g. '`prod`', '`uat`', '`test1`') - `` is the name of the git branch you would like to deploy A few things will happen when you run this command: 1. Fetch latest changes from git 2. Trigger deployment 3. Stream the deployment log back to your terminal ### Snapshots [](#snapshots) #### List [](#list) You can see a list of snapshots for a specific stack with the command: ``` php naut-cli.phar snapshot:list ``` This will display a table containing columns for: the snapshot id, source environment, mode, size, and created date/time. #### Delete [](#delete) You can delete a snapshot with the command: ``` php naut-cli.phar snapshot:delete ``` #### Create [](#create) You can create a new snapshot for a specific stack/environment with the command: ``` php naut-cli.phar snapshot:create ``` Optionally, you can include the `--mode` flag. This flag sets the type of snapshot to create. Valid options are: - all - db - assets The default if the `--mode` flag is missing is `all`. Example usage: `--mode=assets`. #### Download [](#download) You can download a snapshot with the command: ``` php naut-cli.phar snapshot:download ``` By default, this command will save the snapshot to the current directory with the same name as it exists within the dashboard. It will also display a progress bar while downloading by default. If you would like to save to a different location/filename then you can use he `--to-stdout` option, and run the command like: ``` php naut-cli.phar snapshot:download --to-stdout > /path/to/your/file.sspak ``` When downloading this way the progress bar is not displayed. Build phar from source ---------------------- [](#build-phar-from-source) To build the `naut-cli.phar` file from source run the script `bin/build-phar.sh`. This will create a fresh copy of the phar at `dist/naut-cli.phar`. To do ----- [](#to-do) - Implement more of the deploynaut API ### Health Score 31 — LowBetter than 68% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity11 Limited adoption so far Community11 Small or concentrated contributor base Maturity69 Established project with proven stability Bus Factor1 Top contributor holds 87.3% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~104 days Recently: every ~137 days Total 8 Last Release 2542d ago Major Versions 1.0.0 → 2.0.02017-07-07 2.2.1 → 3.0.02018-12-12 3.0.1 → 4.0.02019-05-29 ### Community Maintainers ![](https://www.gravatar.com/avatar/e0ecd07f8fb11e45afa3f1c323fb9cc3366e118fedf9715ef0e30e01d7de1b32?d=identicon)[guttmann](/maintainers/guttmann) --- Top Contributors [![tyrannosaurusjames](https://avatars.githubusercontent.com/u/3037783?v=4)](https://github.com/tyrannosaurusjames "tyrannosaurusjames (55 commits)")[![jgoodman-tec](https://avatars.githubusercontent.com/u/152564140?v=4)](https://github.com/jgoodman-tec "jgoodman-tec (8 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/guttmann-naut-cli/health.svg) ``` [![Health](https://phpackages.com/badges/guttmann-naut-cli/health.svg)](https://phpackages.com/packages/guttmann-naut-cli) ``` ### Alternatives [laravel/framework The Laravel Framework. 34.6k509.9M17.0k](/packages/laravel-framework)[laravel/dusk Laravel Dusk provides simple end-to-end testing and browser automation. 1.9k36.7M259](/packages/laravel-dusk)[laravel/vapor-cli The Laravel Vapor CLI 31310.7M8](/packages/laravel-vapor-cli)[laravel-zero/framework The Laravel Zero Framework. 3371.4M369](/packages/laravel-zero-framework)[drupal/core Drupal is an open source content management platform powering millions of websites and applications. 19462.3M1.3k](/packages/drupal-core)[ec-cube/ec-cube EC-CUBE EC open platform. 78527.0k1](/packages/ec-cube-ec-cube) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)