Terminal and automation

Zenifra CLI for deployment and terminal operations

Install the official Zenifra CLI, authenticate, create projects, publish with GitHub or Docker/OCI, inspect logs, and use an API key in CI/CD automation.

Open console View CLI docs View quickstart

From the first command to an observed deployment

The CLI brings together the paths developers repeat every day: install, authenticate, create a project, publish, follow builds, and operate the application.

Installation

npm install -g @zenifra/cli
zenifra --help

Authentication

zenifra auth login
zenifra auth api-key --key znf_your_key

Create project

zenifra plans --type http
zenifra create project
zenifra create project --name app-api --plan basic --payment-mode hourly --config @examples/http-github-project.json

GitHub deployment

zenifra deploy --project <project-id> --branch main
zenifra deploy watch --project <project-id> --build <build-id>

When to use Zenifra CLI

A quick map for teams evaluating whether Zenifra fits their technical workflow.

Developers who live in the terminal

Install, authenticate, create projects, and trigger deployments without leaving the local workflow.

Teams with a pipeline

Use an organization API key in CI/CD to list projects, trigger deployments, and follow builds.

Production operations

See logs, variables, builds, deployments, URL, and current image through the same binary.

A repeatable flow

Use the CLI interactively in the terminal or with an API key and JSON in pipelines.

Install and authenticate

Use interactive login for personal use or an organization API key for automation.

Create or connect the project

Use the wizard when exploring or configuration files for repeatable flows.

Publish and observe

Trigger GitHub deployment, follow builds, and inspect logs, environment variables, and deployments in the terminal.

Decisions before automating

A few choices define whether the flow better fits local use, production, or CI/CD.

Login or API key

GitHub or OCI

GitHub uses branch deployment; OCI uses an image project and updates through project image set.

Wizard or config

The wizard guides the first use; versioned config gives repeatability to teams and pipelines.

Text or JSON

Use normal output in the terminal and --json when a command feeds scripts or CI/CD.

CLI checklist

Separate the credential, project ID, branch, image, and port before turning local commands into automation. This reduces trial and error in your first terminal deployment.

Node.js and npm available to install @zenifra/cli
Zenifra account or organization API key created in the console
Project ID available for deployment, logs, environment variables, and builds
Main branch defined for GitHub deployment
OCI image and HTTP port defined for Docker/OCI projects

Docker/OCI

zenifra create project --name app-api --plan basic --payment-mode hourly --config @examples/http-project.json
zenifra project image set --project <project-id> --image ghcr.io/your-org/app:main

Logs, environment variables, and history

zenifra projects --type http
zenifra project logs --project <project-id>
zenifra project envs --project <project-id>
zenifra project env add --project <project-id> --name NODE_ENV --value production
zenifra builds --project <project-id>
zenifra deployments --project <project-id>

CI/CD

export ZENIFRA_API_KEY=znf_your_key
zenifra deploy --project <project-id> --branch main --json

Frequently asked questions

Short answers that keep the page practical without duplicating the documentation.

Does this page replace the CLI documentation?

No. It shows the main flow and common commands; details remain in the official documentation.

Which authentication should I use in CI/CD?

Use ZENIFRA_API_KEY in the job environment to avoid saving a local session on the runner.

Is there direct image deployment in the CLI?

The OCI flow creates a project with image configuration or updates the image with project image set.

How do I see complete commands and examples?

Use zenifra help <command> or zenifra <command> --help to see usage, examples, and expected output.