@metatell/bot-cli
v1.0.2
Published
CLI tool for Metatell bot development and testing
Downloads
813
Readme
@metatell/bot-cli
Command-line tools for developing and testing metatell bots.
Requirements
- Node.js 20 or later. Node.js 22 is recommended.
Install
npm install -g @metatell/bot-cliRun without global installation:
npx @metatell/bot-cli <command>Install as a development dependency:
npm install --save-dev @metatell/bot-cliUsage
metatell-bot https://metatell.app/ROOM_ID
metatell-bot https://metatell.app/ROOM_ID -n "MyBot"
metatell-bot https://metatell.app/ROOM_ID -dCommands
Interactive Mode
metatell-bot https://metatell.app/ROOM_ID [options]
metatell-bot interactive https://metatell.app/ROOM_ID [options]Available interactive commands:
| Command | Description |
| --- | --- |
| /say <message> | Send a chat message. |
| /move <x> <y> <z> | Move the bot avatar. |
| /look <x> <y> <z> | Look at a coordinate. |
| /look @<username> | Look at a user. |
| /nearby [radius] | Show nearby users. Default radius is 10 m. |
| /users | Show all users in the room. |
| /status | Show connection status. |
| /info | Show bot information. |
| /avatar <id> | Change the bot avatar. |
| /assets | List available avatars. |
| /anime <name> | Play an animation. |
| /animation <name> | Play an animation. |
| /animations | List available animations. |
| /stop | Stop the current animation and return to idle. |
| quit or exit | Exit the CLI. |
Connection Test
metatell-bot connect https://metatell.app/ROOM_ID [options]Room Inspection
metatell-bot inspect https://metatell.app/ROOM_ID [options]Options
| Option | Alias | Description | Default |
| --- | --- | --- | --- |
| --name | -n | Bot display name. | MetatellCLI |
| --debug | -d | Enable debug logs. | false |
Local Development
git clone https://github.com/urth-inc/metatell-ai-bot.git
cd metatell-ai-bot
npm install
cd packages/cli
npm run build
npm link
metatell-bot --version
metatell-bot --helpUseful commands:
npm run dev
npm run build
npm run typecheck
cd ../.. && npm test packages/cli/src/cli.spec.tsRemove the global link:
npm unlink -g @metatell/bot-cliLicense
MIT
