Build your first Assistant

1 · Create

Generate a valid starter

Terminal bash

shimpz assistant new hello-assistant
cd hello-assistant

The generator pins the SDK version that its CLI supports and creates every required source file, including the Assistant icon. It does not need Docker or a running Shimpz Space.

2 · Inspect

Know the files you own

Project tree text

hello-assistant/
├── .gitignore
├── README.md
├── actions/hello_world.py
├── icon.png
├── lib/hello.py
├── tests/test_hello.py
├── pyproject.toml
└── shimpz.toml

shimpz.toml declares identity, Genesis, network intent, and optional Integrations.
actions/hello_world.py declares the typed hello-world Action, which asks for approval with English shimpz.text request copy before it greets.
pyproject.toml pins Python 3.14 and the Shimpz SDK.
icon.png is the Assistant identity image included in the immutable source package.

3 · Verify

Validate the package and invoke the Action

Terminal bash

shimpz assistant check
shimpz assistant run hello-world --input '{"name":"Ada"}'

shimpz assistant check must report Assistant is valid. The Action run then shows its approval request in English and waits for your answer; type y and press Enter:

Terminal text

request: Send a greeting
request: Greet Ada with a Hello World message.
request: Approve this action? [y/N]
y

The Action then prints:

stdout json

{"message":"Hello, Ada!"}

Any other answer denies the request and ends the run without a result.

If it fails

Fix the first visible error

shimpz: command not found: Install the CLI, open a new terminal, and run shimpz --version before retrying.
SDK or Python download fails: Check network access and retry once. The CLI manages its own Python 3.14 and uv.
Assistant validation fails: Read the first reported file and field, correct it, then run shimpz assistant check again.