@runonbitcoin/runbot

🤖 runbot

Runbot is CLI tool to help you create, deploy and manage your Run code.

Usage

Within a new or existing npm package, install runbot as a dependency. You must also install run-sdk version 0.6.38 or greater.

npm install -D @runonbitcoin/runbot
npm install run-sdk@^0.6.38
# or using yarn
yarn add --dev @runonbitcoin/runbot
yarn add run-sdk@^0.6.38

Once installed, the CLI can be invoked using npx or yarn.

npx runbot --help
# or using yarn
yarn runbot --help

Commands

Init

runbot init [dir]

Initialise a new Run code library in the current working directoy.

• [dir] - Run source directory (default: runsrc)

runbot init

Code

runbot code add <location> [file]

Add existing on-chain code to the current library. Must own the code unless using --fork.

• <location> - Run location of code
• [file] - File path to save code to (default: determined by code name)
• --fork - Fork code you don't own into your library (default: false)
• --module - JavaScript module format ("cjs" or "esm", default: determined by package.json)

runbot code add 72a61eb990ffdb6b38e5f955e194fed5ff6b014f75ac6823539ce5613aea0be8_o1

runbot code new <file> [name]

Generate a new Run source code file in the current library.

• <file> - File name/path code will be generated at
• [name] - Name of code (default: determeined by file name)
• --type - JavaScript code type ("class", "function" or "jig", default: "jig")
• --module - JavaScript module format ("cjs" or "esm", default: determined by package.json)

runbot code new my-coin.js

runbot code info [source]

Display the Run source code deployment status.

• [source] - Source filename or path glob (default: "*")
• --network - Bitcoin network (default: "main")
• --verbose - Show code locations and presets

runbot code info

runbot code deploy [source]

Deploy the Run source code to the blockchain.

• [source] - Source filename or path glob (default: "*")
• --network - Bitcoin network (default: "main")

runbot code deploy

runbot code bundle [source] <target>

Export Run source code to JavaScript bundle.

• [source] - Source filename or path glob (default: "*")
• <target> - Bundle target file path
• --module - JavaScript module format ("cjs" or "esm", default: determined by package.json)
• --network - Bitcoin network (default: "main")

runbot code bundle app/bundle.js

Dependencies

runbot deps add <location..>

Add existing Run code as a dependency.

• <location..> - Run location(s)
• --network - Bitcoin network (default: "main")

runbot deps add 05f67252e696160a7c0099ae8d1ec23c39592378773b3a5a55f16bd1286e7dcb_o2

runbot deps info

Display project dependency tree.

• --all - Show all child dependencies
• --network - Bitcoin network (default: "main")
• --verbose - Show detailed dependency tree

runbot deps info

runbot deps remove <name>

Remove a code dependency.

• <name..> - Code name(s)
• --network - Bitcoin network (default: "main")

runbot deps remove txo

runbot deps update <name> [location]

Update a code dependency. If location is ommitted, will sync to latest version.

• <name> - Code name
• [location] - Run location
• --network - Bitcoin network (default: "main")

runbot deps update txo

Purse

runbot purse info

Display and top-up purse balance.

• --network - Bitcoin network (default: "main")

runbot purse info

runbot purse sweep <address>

Sweep purse balance to an address.

• <address> - Bitcoin address
• --network - Bitcoin network (default: "main")

runbot purse sweep 1NwCzqeKHgwEp2ZvoUZ8j7vqsPFfP6T6kh

License

TokenKit is open source and released under the MIT License.

Copyright (c) 2022 Run Interactive, Inc.