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.0.tar.gz (7.6 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.0-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aios_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 7.6 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.0.tar.gz
Algorithm Hash digest
SHA256 362299c2071eb83021ba76789d3ec8483d9939533245ee7660a75f5023ce3138
MD5 aac4f8839bdc584172c8f5b4442fbde6
BLAKE2b-256 e8dbaf6cd11aec8ca1187eb022b3313c0da08bef1d036969c24f3c7fedfb7a8a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aios_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.3 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d04b55d4eeadf36b4b42f755ed987a2d8d680cf9053f320e65bb2055a1f2fc71
MD5 f4004a1e80fa46211d87b505903bd30a
BLAKE2b-256 d83961e5758d1687c7704c7738c6d98ecb351119c7236f403bd0cd9e0d6c27a8

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