Skip to content

README.md: Add instructions to create bot account #238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joallard wants to merge 2 commits into
base: master
Choose a base branch
from
Open

README.md: Add instructions to create bot account #238

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9200403
README.md: Add instructions to create bot account
joallard May 4, 2020
75f5017
!fixup last
joallard May 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,29 @@ Keybase bot-scripting for Node.js - now written all in TypeScript! Send encrypte

You can use this module to script basic Keybase commands such as sending and reading messages and attachments, and managing teams.

- [Creating the bot account](#creating-the-bot-account)
- [Installation](#installation)
- [Hello World](#hello-world)
- [API](#api)
- [Contributions](#contributions)

## Creating the bot account
If that's not already done, create an account for your new bot.

First create a token:
```bash
$ keybase bot token create
NucJHeRHtzjCRPYprX7PFdRyebcf4Ug9
```

Then, create your bot with the token and its username, returning its paper key:
```bash
$ keybase bot signup -u friendlybot -t NucJHeRHtzjCRPYprX7PFdRyebcf4Ug9
spider engine secret duck will maybe read secret message ohno act normal screwdriver fridge banana banana
```

You're all set! For other account commands, run `keybase help bot`.

## Installation

1. Install Node.js 12 or above.
Expand Down