Skip to content

Bannerets/keybase-export

Repository files navigation

keybase-export

npm

A tool to export keybase chats.

Features

  • Configuration file
  • Export to jsonl (json lines)
  • Export to SQLite
  • Export to ElasticSearch
  • Watcher for new messages
  • Attachment downloading
  • Incremental export

Configuration

See config.example.json for a config example and config.ts for the config schema.

Usage

  1. Install Node.js.

  2. Clone the repository from Github and run the installation commands:

git clone https://github.com/Bannerets/keybase-export.git
cd keybase-export
npm install
npm run build
  1. Copy config.example.json to config.json and edit it. At least, chats, username and paperkey should be replaced.

  2. Launch:

$ ./bin/keybase-export
# or: $ node dist

Optionally, the configuration file can be passed as a cli argument:

$ ./bin/keybase-export config-2.json

Debug mode: DEBUG=keybase-export* ./bin/keybase-export


Another way to install is via NPM (not recommended, the version might be outdated):

npm install -g keybase-export
# local installation: $ npm install keybase-export

And launch:

$ keybase-export [<config>]