Skip to main content

Developer SDK and CLI for AIOS BIZ modules

Project description

AIOS BIZ SDK & CLI Tool

The AIOS BIZ Developer SDK and CLI is a Click-based tool that automates the creation, validation, packaging, and installation of modular AIOS BIZ modules.

Installation

Recommended — from PyPI

pip install aios-cli

Verify the installation:

aios --help

Alternative — from the platform's Developer Portal

Download the SDK ZIP from your AIOS BIZ instance's Developer Portal and install it in an isolated Python environment:

pip install -e /path/to/extracted/aios-sdk

Development (within the backend repo)

cd backend
uv pip install -e ../sdk
uv run aios --help

Quickstart

# 1. Scaffold a new module
aios init invoice --name "Invoice Manager" --vendor "MyCompany" --resource "invoice"

# 2. Validate the module structure
aios validate ./invoice

# 3. Build a deployable .aios package
aios build ./invoice

# 4. Install on your AIOS BIZ Core instance
aios install ./invoice.aios --url http://your-core-url --token <your_jwt_token>

CLI Commands

1. Initialize a Module

Scaffold a new module skeleton (interactively, or via flags):

aios init invoice --name "Invoice Manager" --vendor "MyCompany" --resource "invoice" --ui-mode "schema"

Options:

  • -n, --name TEXT: Display name of the module.
  • -v, --vendor TEXT: Vendor/Author namespace.
  • -r, --resource TEXT: Lowercase singular initial resource name.
  • -u, --ui-mode [schema|custom]: Frontend rendering mode.
  • --sample-tool/--no-sample-tool: Include standard AI-callable tool stub.

2. Validate a Module

Run checks against the manifest.json schema and verify python code syntax rules:

aios validate ./invoice

3. Build a Package

Package the module source files into a .aios archive:

aios build ./invoice

This runs validation first automatically, refusing to build if validation fails.

4. Install a Package

Install the built package on a running Core backend:

aios install ./invoice.aios --url http://127.0.0.1:8000 --token <your_auth_jwt_token>

Resources

  • SDK Download also available from your AIOS BIZ Core instance's Developer Portal

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

aios_cli-0.1.1.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

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

aios_cli-0.1.1-py3-none-any.whl (15.5 kB view details)

Uploaded Python 3

File details

Details for the file aios_cli-0.1.1.tar.gz.

File metadata

  • Download URL: aios_cli-0.1.1.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for aios_cli-0.1.1.tar.gz
Algorithm Hash digest
SHA256 5e0a8e410bb69fa7cd1b41e941d1d855b31bff8b80457378c46b042298b1b9d2
MD5 125c2547890e0b64f1b097936a3b02aa
BLAKE2b-256 7078b1144d23a4e1097c0d2e5c886c7d0902e6388edb2ac9560110bd1081c872

See more details on using hashes here.

File details

Details for the file aios_cli-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: aios_cli-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 15.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.8

File hashes

Hashes for aios_cli-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fbb31121c4311e21920725190fb4954fcefbf39f903c5212aea22a2ccdac73c3
MD5 46f628e324031d67763d562b87cca965
BLAKE2b-256 a41df46ba0aad58b0afe647d5df90c241a3ee83f69510a6063a250f201089346

See more details on using hashes here.

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