CLI

A Command Line Interface for Agents is available through the agentctl script.

Warning

agentctl is experimental, expect its interface and implementation to change in the near future

To use the CLI, define first define an .env file with the Agent configuration parameters. You can find an example at /example_agent/test_stories/.env.template.

class Agentctl

This is the base Agentclt class.

dev_server()

Start a development server to enable fulfillments.

>>> dotenv -f .env run agentctl upload

Make sure that your server is reachable from the prediction service (e.g. by using a ngrok tunnel if you are developing locally) on the host and port defined by the I_WEBHOOK_HOST and I_WEBHOOK_PORT env variables; the remote agent will be configured to use those values in Agentctl.upload().

export(path)

Export the Agent to file

>>> dotenv -f .env run agentctl export --path my_agent.zip

Parameters

path (str) – path to the file the Agent will be exported to

upload()

Upload the Agent its configured service

>>> dotenv -f .env run agentctl upload