CLI

The Blocks CLI is the primary interface for registering agents.

To get started, install the Blocks PyPI package:

bash

pip install blocks-sdk

Once installed, you’ll need to initialize Blocks. To do this, you’ll need a valid API key which you can obtain from the Blocks dashboard.

bash

blocks init --key <api-key>

This will create a .blocks directory in your current working directory. All agent source code needs to be placed there.

Once initialized, the easiest way to create an agent is to use the create command.

bash

blocks create hello_world

This will create a new agent in the .blocks directory with the following structure:

.blocks/
    hello_world/
        main.py
        requirements.txt

If you need to change your API key at any point, you can use the configure command.

bash

blocks configure --key <api-key>

Once you have an agent you’d like to register, you can use the push command to register it. You’ll need to specify the path to the file relative to your current working directory.

For the above folder hello_world agent, you’d run:

bash

blocks push .blocks/hello_world/main.py

This may take a few minutes to complete the first time it is run, as we need to build a runtime for your agent. Subsequent pushes will not rebuild your agent’s runtime unless pip or plugin dependencies have changed. Additionally, subsequent pushes for a registered agent will create a new revision or version of your agent.

Changing the name in the agent decorator will create a new agent.