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:

# Authenticate with Synvex
nexroo login

# Run a workflow
nexroo run workflow.json

Usage

Authentication Commands

Login

nexroo login

Opens browser for Zitadel authentication. Credentials stored encrypted for 30 days.

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 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 <package> --upgrade
    

Storage Locations

  • Engine binary: ~/.nexroo/bin/nexroo-engine
  • Addon packages: System Python's site-packages
  • Encrypted tokens: ~/.nexroo/auth_token.enc
  • Encryption key: ~/.nexroo/.key
  • Addon metadata: ~/.nexroo/installed_packages.json

Troubleshooting

For debug use '--verbose'

Authentication fails

nexroo logout
nexroo login

Token expired

nexroo status
nexroo login   # Re-authenticate

Documentation

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

License

PolyForm Noncommercial License 1.0.0 - see LICENSE file for details. Or on https://polyformproject.org/licenses/noncommercial/1.0.0

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.3.0.tar.gz (21.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.3.0-py3-none-any.whl (24.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: nexroo_cli-1.3.0.tar.gz
  • Upload date:
  • Size: 21.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.3.0.tar.gz
Algorithm Hash digest
SHA256 b94c53dfffdf05b6307352c50423840096e1f762c143bc082e8da61a3b8b2352
MD5 297e4407542a66fbd7d56514b8c5d7ea
BLAKE2b-256 af2de88549308a2f5e5d0e7277e5093e471d6f0c5d2cec3d2cd2d236dc28b77d

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: nexroo_cli-1.3.0-py3-none-any.whl
  • Upload date:
  • Size: 24.3 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c13805b4afebc90b11ae0e38a8198031256900f65cc0c252984e0c86d351089b
MD5 acface0cfc962a2b26ed4300ca65091d
BLAKE2b-256 ded16b066b46e25da50fe433926e182f366e9ec4d30e7b9a20d0fbc03ccf14f7

See more details on using hashes here.

Provenance

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