Skip to main content

Nifectl CLI Guide

The Nifectl CLI (Command Line Interface) is a powerful tool designed to help developers and operators manage applications and cloud resources directly from the terminal. It connects seamlessly to the Nife.io platform, allowing you to authenticate, deploy, monitor, and scale your workloads effortlessly.

Overview​

With the Nifectl CLI, you can perform essential operations such as:

  • Initialize a new application using the init command.
  • Deploy your app with the deploy command.
  • Monitor deployments and logs using dashboard and logs.
  • Manage resources, regions, clusters, and secrets.
  • Check status or resume/suspend applications anytime.

To read more or explore advanced use cases, run the nifectl docs command to open the official documentation.

Usage​

nifectl [command] [flags]

Available Commands​

  • apps – Manage applications.
  • auth – Manage authentication.
  • builtins – View and manage Nifectl deployment built-ins.
  • cluster – Bring Your Own Cluster (BYOC).
  • config – Manage app configurations.
  • dashboard – Open Nife Web UI for your app.
  • deploy – Deploy an app to the Nife platform.
  • destroy – Permanently delete an app.
  • docs – View Nife documentation.
  • help – Get help for any command.
  • history – List an app’s change history.
  • init – Initialize a new application.
  • list – List Nife resources.
  • logs – View application logs.
  • metrics – View monitoring metrics.
  • move – Move an app to another organization.
  • open – Open a browser to the deployed application.
  • orgs – Manage Nife organizations.
  • platform – Display Nife platform information.
  • regions – Manage regions.
  • releases – List app releases.
  • resume – Resume an application.
  • status – Show app status.
  • suspend – Suspend an application.
  • secrets – Manage app secrets.
  • version – Show version information for Nifectl.
  • workload – Manage workloads in Nife.

Options​

  -t, --access-token string   Nife API Access Token
  -h, --help                  Help for nifectl
  -j, --json                  JSON output format

Best Practices​

  • Regularly update your Nifectl CLI to the latest version for improved features and bug fixes.
  • Use --json output for easier integration with automation scripts.
  • Securely manage access tokens and configuration files.

Summary​

The Nifectl CLI is the backbone of managing your Nife applications from the command line. With comprehensive command coverage—from deployment to monitoring—it enables developers to take full control of hybrid and edge cloud environments efficiently.