metatell Bot SDK - v2.0.0
    Preparing search index...

    Module @metatell/bot-cli

    @metatell/bot-cli

    Command-line tools for developing and testing metatell bots.

    • Node.js 22.12 or later (commander 15 requirement). Node.js 24 is recommended.
    npm install -g @metatell/bot-cli
    

    Run without global installation:

    npx @metatell/bot-cli <command>
    

    Install as a development dependency:

    npm install --save-dev @metatell/bot-cli
    
    metatell-bot https://metatell.app/ROOM_ID
    metatell-bot https://metatell.app/ROOM_ID -n "MyBot"
    metatell-bot https://metatell.app/ROOM_ID -d
    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.
    metatell-bot connect https://metatell.app/ROOM_ID [options]
    
    metatell-bot inspect https://metatell.app/ROOM_ID [options]
    
    Option Alias Description Default
    --name -n Bot display name. MetatellCLI
    --debug -d Enable debug logs. false
    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 --help

    Useful commands:

    npm run dev
    npm run build
    npm run typecheck
    cd ../.. && npm test packages/cli/src/cli.spec.ts

    Remove the global link:

    npm unlink -g @metatell/bot-cli
    

    MIT

    CliOptions
    connectCommand
    inspectCommand
    startInteractiveMode