Skip to main content

CLI wrapper for ai-rooms-script with Zitadel authentication

Project description

Nexroo CLI

📚 Full Documentation: https://docs.nexroo.ai

CLI wrapper for Nexroo workflow engine with authentication and package management.

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.

Running Workflows

With authentication (SaaS features enabled):

nexroo run workflow.json [entrypoint]

Without authentication (local-only mode):

nexroo run workflow.json --no-auth

Additional Options

nexroo run workflow.json [entrypoint] [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
  • 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

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.4.0.tar.gz (20.6 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.4.0-py3-none-any.whl (23.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nexroo_cli-1.4.0.tar.gz
  • Upload date:
  • Size: 20.6 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.4.0.tar.gz
Algorithm Hash digest
SHA256 8c4d410c667b28513b25d673cb83f36ff6e84d1dd510ce18b6b0fb1735a118f2
MD5 5dc663bc0d70f84509ba6710bcc691f5
BLAKE2b-256 7a9fbaf68292316de44e34351c8b182933334842d07c4b30ac8c48f21c613fdf

See more details on using hashes here.

Provenance

The following attestation bundles were made for nexroo_cli-1.4.0.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.4.0-py3-none-any.whl.

File metadata

  • Download URL: nexroo_cli-1.4.0-py3-none-any.whl
  • Upload date:
  • Size: 23.0 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 289c025e521a6ff18b01fb2c1847a1c82c15ac194ee8fb7a2f15977a75c4ff58
MD5 d94148cc1743d553467e36f183ea8811
BLAKE2b-256 515bcf8dcbbade1b6df968435225a1ec0e2da0a27f30a50e5614580769539465

See more details on using hashes here.

Provenance

The following attestation bundles were made for nexroo_cli-1.4.0-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