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> --helpto 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
.envfile in your project with:SHELLSMITH_BASYX_ENV_HOST=https://your-host:1234
-
Use the
--hostoption 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.
1 maintainer
Metadata
1 maintainer
Release files for aas-cli 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aas_cli-0.0.1.tar.gz | 11.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aas_cli-0.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 28.8 kB
Release files / aas_cli-0.0.1.tar.gz
| Download URL | aas_cli-0.0.1.tar.gz |
|---|---|
| Size | 11.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a4d368f1ed99cf166e8ef78af842c4dbeedca3a8c13e1b0a0b925af3c3bdbd51
|
|
BLAKE2b-256 checksum How to use checksums |
a958c89fafa6eb5678f13627f52fed7e366c93ebebdd3cf2661ff03c5361d6c4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.1
|
Release files / aas_cli-0.0.1-py3-none-any.whl
| Download URL | aas_cli-0.0.1-py3-none-any.whl |
|---|---|
| Size | 17.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
be39ad90dde34323bab8224c485c7427df0267edb82c61da8716061bab1cb69c
|
|
BLAKE2b-256 checksum How to use checksums |
908ab4433a7cb722541ad17cd958466f1a7b45cbec6de71eacf187462bae0dbe
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.13.1
|
