Skip to main content

CLI wrapper for ai-rooms-script with Zitadel authentication

Project description

Nexroo CLI

A command-line interface for running Nexroo Engine anywhere and interacting with the Nexroo SaaS automation platform.

CLI & Engine Documentation: docs.nexroo.ai

Website: nexroo.ai


Automate your processes, deploy micro-SaaS products, and scale seamless.

Nexroo platform is divided in four components, the engine and CLI, the SaaS platform, the micro-saas package and the addons.

Engine, CLI and micro-saas renderer are all free to use, all can be easily managed from our SaaS to edit with no-code editor, versionning, environments, and push multiples workflows to the deployed engine or micro-saas you are managing for your clients.

Engine Addons are open source, all viewable in nexroo-ai github repository.

Screenshots

Nexro Engine standalone usage

Standalone engine to run in any environment, most lightweight Nexroo Engine CLI screenshot

Micro-SaaS usage

Render and deploy micro-SaaS on-premise for your clients Micro-SaaS screenshot

SaaS usage

Manage and publish client-ready revisions (no-code) SaaS screenshot

Deploy only what your client really need, manage all from one place

Escalidraw Nexroo Components


Prerequisites

Python 3.11+ is required for addon packages to work. The engine itself is a standalone binary, but addons are installed to your system Python.

  • Windows: Download Python
  • Linux: apt install python3 or yum install python3
  • macOS: brew install python3

Installation

Quick Install (Recommended)

# install CLI
pip install nexroo-cli
# use CLI to install engine
nexroo install

or

Linux/macOS:

curl -fsSL https://raw.githubusercontent.com/nexroo-ai/nexroo-cli/main/install.sh | bash

Windows (PowerShell):

irm https://raw.githubusercontent.com/nexroo-ai/nexroo-cli/main/install.ps1 | iex

Quick Start

After installation, authenticate and run your first workflow:

(optionnal, for SaaS features like pulling/pushing workflows revisions)

# Authenticate with Nexroo
nexroo login

Run a workflow

nexroo run workflow.json

Usage

Authentication Commands

Login

nexroo login

Opens browser for Zitadel authentication.

Logout

nexroo logout

Clears saved credentials.

Status

nexroo status

Shows authentication status and token expiration.

Workflow Management

Pull Workflow from Repository

# Pull from default Nexroo repository
nexroo workflow pull @nexroo/workflow-name

# Pull from custom repository
nexroo workflow pull @owner/repo:workflow-name

# Pull with custom name
nexroo workflow pull @nexroo/workflow-name my-custom-name

# Skip configuration during pull
nexroo workflow pull @nexroo/workflow-name --no-config

Load Local Workflow

# Load workflow from local file
nexroo workflow load ./my-workflow.json

# Load with custom name
nexroo workflow load ./my-workflow.json my-workflow

# Skip configuration
nexroo workflow load ./my-workflow.json --no-config

Configure Workflow

# Configure workflow (interactive guided process)
nexroo workflow config set my-workflow

# Show current configuration
nexroo workflow config show my-workflow

List Workflows

# List installed workflows
nexroo workflow list

# List available workflows from repository
nexroo workflow list --available

Delete Workflow

nexroo workflow delete my-workflow

Running Workflows

# Set required environment variables for secrets
export OPENAI_API_KEY=sk-...

# Run installed workflow
nexroo run my-workflow

# Run local workflow file
nexroo run workflow.json [entrypoint]

# Without authentication (local-only mode)
nexroo run workflow.json --no-auth

Additional Options

Refer to Nexroo Documentation for all available options.

Update

pip install --upgrade nexroo-cli
nexroo update

Uninstall

# Uninstall engine, addons, and all data
nexroo uninstall

# Remove the CLI package
pip uninstall nexroo-cli

Addon Packages

Installing Addons

Addons extend the engine with additional capabilities (AI providers, databases, storage, etc.).

# Install an addon
nexroo addon install redis

# List available addons
nexroo addon list --available

# List installed addons
nexroo addon list

Troubleshooting Addon Issues

If the engine can't find an addon:

  1. Verify Python 3.11+ is installed:

    python3 --version
    
  2. Check addon installation:

    nexroo addon list
    python3 -m pip list | grep rooms-pkg
    
  3. Reinstall addon:

    nexroo addon install <addon_name> --upgrade
    

Storage Locations

  • Engine: Installed via pip to Python's site-packages (available as nexroo-engine or nexroo run)
  • Addon packages: System Python's site-packages
  • Workflows: ~/.nexroo/workflows/
  • Workflow configurations: ~/.nexroo/workflows/*.config.json
  • Encrypted tokens: ~/.nexroo/auth_token.enc
  • Encryption key: ~/.nexroo/.key
  • Addon metadata: ~/.nexroo/installed_packages.json
  • Engine version: ~/.nexroo/.engine_version
  • Download cache: ~/.nexroo/cache/

Troubleshooting

For debug use '--verbose'

Authentication fails

nexroo logout
nexroo login

Token expired

nexroo status
nexroo login   # Re-authenticate

Documentation

See Nexroo Engine Documentation to know how to use Nexroo workflow engine.

License

Nexroo Engine Free Use License v1.0 - see LICENSE file for details.

Support

Contact

Adrien EPPLING
mail: adrien.eppling@nexroo.ai
linkedin: https://www.linkedin.com/in/adrien-eppling/

Romain MICHAUX
mail: romain.michaux@nexroo.ai
linkedin: https://www.linkedin.com/in/romain-michaux/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nexroo_cli-1.6.1.tar.gz (30.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nexroo_cli-1.6.1-py3-none-any.whl (32.8 kB view details)

Uploaded Python 3

File details

Details for the file nexroo_cli-1.6.1.tar.gz.

File metadata

  • Download URL: nexroo_cli-1.6.1.tar.gz
  • Upload date:
  • Size: 30.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nexroo_cli-1.6.1.tar.gz
Algorithm Hash digest
SHA256 c9776c1c907fc722b96e3cd395e57ad5f0ff5d8b20971d2c8538ad4f3b8d70c6
MD5 a399924a37fb085770fbabdf8aeae93b
BLAKE2b-256 a38b70735d47d355e70e3cc0186cc8fda216c46ec6f9db9ada0220a99d07be4a

See more details on using hashes here.

Provenance

The following attestation bundles were made for nexroo_cli-1.6.1.tar.gz:

Publisher: release.yml on nexroo-ai/nexroo-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file nexroo_cli-1.6.1-py3-none-any.whl.

File metadata

  • Download URL: nexroo_cli-1.6.1-py3-none-any.whl
  • Upload date:
  • Size: 32.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for nexroo_cli-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f1f518d513d4c045a89be3fd0c864ace5f5a91bc9424bd4829f1d8b7a1a269f8
MD5 32b4cc2b0869d2913e04da4555a64bbc
BLAKE2b-256 4067d7726f5e60c2a954e2cfd99c8292aadc5a6b0dd201b42b2c6eab800fea9c

See more details on using hashes here.

Provenance

The following attestation bundles were made for nexroo_cli-1.6.1-py3-none-any.whl:

Publisher: release.yml on nexroo-ai/nexroo-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page