Documentation: https://shellsmith.pages.dev/cli

aas-cli is a Python CLI for managing Asset Administration Shells (AAS), Submodels, and Submodel Elements via the Eclipse BaSyx REST API.

Installation

pip install aas-cli

Requires: Python 3.10+

Usage

aas --help

Command	Description
info	Display the current Shell tree and identify issues.
upload	Upload a single AAS file or all AAS files from a folder.
nuke	☢️ Delete all Shells and Submodels (irrevocable).
encode	Encode a value (e.g. Shell ID) to Base64.
decode	Decode a Base64-encoded value.
get	Get Shells, Submodels, and Submodel Elements.
delete	Delete Shells, Submodels, or Submodel Elements.
update	Update Shells, Submodels, or Submodel Elements.
create	Create new Shells, Submodels, or Submodel Elements.

ℹ️ Run aas <command> --help to view subcommands and options.

➡️ Full CLI reference: shellsmith.pages.dev/cli

Configuration

The default AAS environment host is:

http://localhost:8081

You can override it in several ways:

• Set the environment variable:

  SHELLSMITH_BASYX_ENV_HOST=https://your-host:1234

• Create a .env file in your project with:

  SHELLSMITH_BASYX_ENV_HOST=https://your-host:1234

• Use the --host option with any CLI command:

  aas get shells --host https://your-host:1234

🤝 Contributing

We welcome contributions!

See the Contributing Guide for setup, testing, and coding standards.