PHPackages northstack/northstack-client - 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. northstack/northstack-client ActiveLibrary northstack/northstack-client ============================ Commands for serverless environment management 0.0.4(6y ago)757.6k1[6 issues](https://github.com/northstack/northstack-client/issues)[3 PRs](https://github.com/northstack/northstack-client/pulls)GPL-3.0-onlyPHPPHP ^7.1 Since Feb 4Pushed 5y ago3 watchersCompare [ Source](https://github.com/northstack/northstack-client)[ Packagist](https://packagist.org/packages/northstack/northstack-client)[ RSS](/packages/northstack-northstack-client/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (4)Dependencies (16)Versions (13)Used By (0) northstack-client ================= [](#northstack-client) CLI Client and PHP Library to access the NorthStack NorthStack APIs [![Build status](https://camo.githubusercontent.com/4e135175df3085db883f50fa7c54a2c0ef40108e706208c606bb22de1b2ebe6b/68747470733a2f2f62616467652e6275696c646b6974652e636f6d2f32643236346433363539653630353538636164373566343061613666633439313632363230633566333666613334653030612e737667)](https://buildkite.com/pagely/northstack-client) Installation ============ [](#installation) Requirements ------------ [](#requirements) There are two ways to install and run the NorthStack CLI. The primary means is a native install (which requires you to have PHP 7.2 installed) and a docker-based wrapper which does not. Both installation methods require you to have docker installed. requirementnativedockerdocker17.09+17.09+php7.2+N/AOSLinux or OSXLinuxThe native install method is preferred and more performant, so it's best if you're able to install PHP >= 7.2 for your operating system. If you're running a modern Linux distro chances are you can just `$packageManager install php72`. If you're using on OSX the easiest way to do this is use [homebrew](https://brew.sh/). Install ------- [](#install) ``` git clone https://github.com/northstack/northstack-client.git cd northstack-client ./bin/install.sh ``` Some installation settings are configurable via CLI arguments: ``` -a Set the app directory (default = $HOME/northstack/apps) -p Set the install prefix (default = $HOME/.local) -m docker|native Set the install method (default = auto) -d Install in dev mode (default = false) -n Don't prompt for any input (default = no) ``` Post-install ------------ [](#post-install) The CLI is installed to `$INSTALL_PREFIX/bin` (default `~/.local/bin`), which may or may not already be in your `$PATH`. The installer attempt to update your rc files for you if this is the case: ``` [2019-06-26 14:50:00] [warn] /home/ns/.local/bin is not in your $PATH Would you like us to update your .bashrc/.zshrc files? Enter yes/no (default = no): yes 101a102,104 > # NorthStack START > PATH=/home/ns/.local/bin:$PATH > # NorthStack END [2019-06-26 14:51:39] [info] Updating: /home/ns/.bashrc ``` Make sure to `source ~/.bashrc` after this! The CLI also supports tab-completion. The process for enabling this varies from platform to platform, but in a pinch you can also just add the completion hook to your bashrc: ``` $ ~/.local/bin/northstack _completion --generate-hook --program northstack >> ~/.bashrc ``` Using the client ================ [](#using-the-client) Login ----- [](#login) ``` northstack auth:login my@northstack-username.com ``` This will save a login token to `~/.northstacklogin`. The login will be good for 14 hours. After that you will need to login again. This file will automatically be read by all other commands and used for authorization to the NorthStack API. You may also use your API keys to log in using the `auth:client-login` command. When done, you may use the `auth:logout` command or simply remove the `~/.northstacklogin` file. Commands -------- [](#commands) Executing the `northstack` command by itself will show the commands available. ``` northstack ``` To get usage help for any command, simply prefix the command name with `help` ``` northstack help auth:login ``` Help! ----- [](#help) ### What is my Account ID? [](#what-is-my-account-id) 1. You can get your account ID by logging into and looking at the address in your browser. Your account ID will be displayed on the dashboard labeled `Account ID`. 2. If you are a collaborator and need the ID for another account, log in to console (link above) and use the account switcher (click your name in the upper right) and switch to the organization in question. The `Account ID` on the dashboardwill change to reflect the current organization that you are viewing. ### Health Score 27 — LowBetter than 49% of packages Maintenance3 Infrequent updates — may be unmaintained Popularity28 Limited adoption so far Community15 Small or concentrated contributor base Maturity52 Maturing project, gaining track record Bus Factor1 Top contributor holds 54.6% 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 ~40 days Total 4 Last Release 2507d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/51c9f0299b163ebf9be813ce0f81ae99a7b093144a42409dd3067c500319522e?d=identicon)[jeichorn](/maintainers/jeichorn) --- Top Contributors [![mm-pagely](https://avatars.githubusercontent.com/u/20521636?v=4)](https://github.com/mm-pagely "mm-pagely (290 commits)")[![baohx2000](https://avatars.githubusercontent.com/u/486322?v=4)](https://github.com/baohx2000 "baohx2000 (96 commits)")[![jeichorn](https://avatars.githubusercontent.com/u/122486?v=4)](https://github.com/jeichorn "jeichorn (85 commits)")[![mlteal](https://avatars.githubusercontent.com/u/3302175?v=4)](https://github.com/mlteal "mlteal (48 commits)")[![flrgh](https://avatars.githubusercontent.com/u/3277009?v=4)](https://github.com/flrgh "flrgh (11 commits)")[![PHLAK](https://avatars.githubusercontent.com/u/53531?v=4)](https://github.com/PHLAK "PHLAK (1 commits)") ### Code Quality TestsPHPUnit Static AnalysisPHPStan Type Coverage Yes ### Embed Badge ![Health badge](/badges/northstack-northstack-client/health.svg) ``` [![Health](https://phpackages.com/badges/northstack-northstack-client/health.svg)](https://phpackages.com/packages/northstack-northstack-client) ``` ### Alternatives [laravel/framework The Laravel Framework. 34.6k509.9M16.9k](/packages/laravel-framework)[shopware/platform The Shopware e-commerce core 3.3k1.5M3](/packages/shopware-platform)[magento/community-edition Magento 2 (Open Source) 12.1k52.1k10](/packages/magento-community-edition)[laravel/vapor-cli The Laravel Vapor CLI 31310.7M8](/packages/laravel-vapor-cli)[wheelpros/fitment-platform-api Magento 2 (Open Source) 12.1k1.2k](/packages/wheelpros-fitment-platform-api)[laravel-zero/framework The Laravel Zero Framework. 3371.4M368](/packages/laravel-zero-framework) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)