orbitdb - CLI for orbit-db

![](http://webchat.freenode.net/?channels=%23orbitdb)
![CircleCI](https://circleci.com/gh/orbitdb/orbit-db-cli)
![npm version](https://www.npmjs.com/package/orbit-db-cli)
![node](https://www.npmjs.com/package/orbit-db-cli)

A CLI tool to manage orbit-db databases.

Quick Start

``$ orbitdb create hello feed /orbitdb/QmfSUsdr34iGio68eMezDzZLCKZTnbsxNJgiNipimZtpi1/hello

$ orbitdb add /orbitdb/QmfSUsdr34iGio68eMezDzZLCKZTnbsxNJgiNipimZtpi1/hello "world" Added QmSwYZheHVa3eWf83XwnWNJtjGG7EWjiWTaTKLeFozVRnz

$ orbitdb get /orbitdb/QmfSUsdr34iGio68eMezDzZLCKZTnbsxNJgiNipimZtpi1/hello "world"

$ orbitdb del /orbitdb/QmfSUsdr34iGio68eMezDzZLCKZTnbsxNJgiNipimZtpi1/hello QmSwYZheHVa3eWf83XwnWNJtjGG7EWjiWTaTKLeFozVRnz Deleted QmSwYZheHVa3eWf83XwnWNJtjGG7EWjiWTaTKLeFozVRnz

$ orbitdb get /orbitdb/QmfSUsdr34iGio68eMezDzZLCKZTnbsxNJgiNipimZtpi1/hello Database '/orbitdb/QmfSUsdr34iGio68eMezDzZLCKZTnbsxNJgiNipimZtpi1/hello' is empty!

$ orbitdb info /orbitdb/QmfSUsdr34iGio68eMezDzZLCKZTnbsxNJgiNipimZtpi1/hello /orbitdb/QmfSUsdr34iGio68eMezDzZLCKZTnbsxNJgiNipimZtpi1/hello > Type: feed > Owner: QmfSUsdr34iGio68eMezDzZLCKZTnbsxNJgiNipimZtpi1 > Data file: ./orbitdb/QmfSUsdr34iGio68eMezDzZLCKZTnbsxNJgiNipimZtpi1/hello.orbitdb > Entries: 0 > Oplog length: 2 / 2 > Write-access: > 04986b1db63cdbe0798699da5054477cfda4ec32dc62563b0c77a94ec8ed8e1946c1cfad0e8c2a681ded54f66dc1614cb0dcfac5b04f1fab3d09ca368f0ff0097f`

`Requirements`

* Node.js >= v8.0.0 * npm

`Install`


From Npm:

`npm install -g orbit-db-cli`

From Git:

`git clone https://github.com/orbitdb/orbit-db-cli.git cd orbit-db-cli/ npm install`

`Run`

`orbitdb`

When installed from Git, the CLI can be run with node ./src/bin

For complete guide on usage, see the CLI help:

`orbitdb help`

Output:

`_ _ _ _ _ | | (_) | | | | ___ _ __| |__ _| |_ __| | |__ / _ \| '__| '_ \| | __| / _ | '_ \
| (_) | | | |_) | | |_ | (_| | |_) |
\___/|_| |_.__/|_|\__| \__,_|_.__/

Peer-to-Peer Database
https://github.com/orbitdb/orbit-db

Usage: orbitdb

Commands:
add [] Add an entry to an eventlog or feed
database. Can be only used on:
eventlog|feed
create Create a new database. Type can be one of:
eventlog|feed|docstore|keyvalue|counter
[aliases: new]
del Delete an entry from a database. Only valid
for data types of: docstore|keyvalue|feed
[aliases: delete, remove]
demo Runs a sequence of commands as an example
[aliases: tour]
drop yes Remove a database locally. This doesn't
remove data on other nodes that have the
removed database replicated.
[aliases: destroy]
get [

] Query the database.
[aliases: query, search]
id Show information about current orbit-db id
import Import a CSV file to a document database
[aliases: csv]
inc [] Increase the value of a counter database.
Default increment is 1. [aliases: increase]
info Show information about a database
[aliases: status]
put Add a document to a document database
replicate Replicate a database with peers.
set Set a value of a key in KeyValue database
version Show information about current orbit-db

Options:
-h, --help Show help [boolean]
``

`$3`

By default, orbit-db creates a data directory ./orbitdb under which metadata of databases is stored along with the actual data blocks saved in IPFS. The metadata can be found under ./orbitdb/QmFoo/database.orbitdb for each database. The data blocks saved in IPFS are in ./orbitdb/ipfs.

To use another orbit-db data directory (as opposed to the default ./orbitdb), set ORBITDB_PATH environment variable to point to the desired data directory. Eg. run the CLI with ORBITDB_PATH=/path/orbitdb orbitdb ...

To use orbit-db with an existing IPFS data repository, set the IPFS_PATH environment variable to the desired IPFS repository path. Eg. run the CLI with IPFS_PATH=/path/to/ipfs orbitdb ...

`Demo`

`node ./src/cli/bin demo FRANK!`

Output:

`_ _ _ _ _ | | (_) | | | | ___ _ __| |__ _| |_ __| | |__ / _ \| '__| '_ \| | __| / _ | '_ \
| (_) | | | |_) | | |_ | (_| | |_) |
\___/|_| |_.__/|_|\__| \__,_|_.__/

Peer-to-Peer Database
https://github.com/orbitdb/orbit-db

> node "src/bin.js" create /orbitdb/demo docstore
/orbitdb/QmcE2HMrDTL3SFV1rcB5GaJVSJFfpFsnfTM4qK8SRScjyj/demo

> node "src/bin.js" put /orbitdb/QmcE2HMrDTL3SFV1rcB5GaJVSJFfpFsnfTM4qK8SRScjyj/demo "{\"_id\":1,\"name\":\"FRANK!\"}" --indexBy name
Added document 'FRANK!'

> node "src/bin.js" get /orbitdb/QmcE2HMrDTL3SFV1rcB5GaJVSJFfpFsnfTM4qK8SRScjyj/demo "FRANK!" --progress
Loading '/orbitdb/QmcE2HMrDTL3SFV1rcB5GaJVSJFfpFsnfTM4qK8SRScjyj/demo'
██████████████████████████████████████████ 1/1 | 100.0% | 00:00:00
Searching for 'FRANK!' from '/orbitdb/QmcE2HMrDTL3SFV1rcB5GaJVSJFfpFsnfTM4qK8SRScjyj/demo'
┌────────────────────────────────────────────────────────────────┬───┐
│name │_id│
├────────────────────────────────────────────────────────────────┼───┤
│FRANK! │1 │
└────────────────────────────────────────────────────────────────┴───┘
Found 1 matches (0 ms)

> node "src/bin.js" drop /orbitdb/QmcE2HMrDTL3SFV1rcB5GaJVSJFfpFsnfTM4qK8SRScjyj/demo yes
Dropped database '/orbitdb/QmcE2HMrDTL3SFV1rcB5GaJVSJFfpFsnfTM4qK8SRScjyj/demo'

Demo finished!
``

`Replicate`

`$3`

Demo:

Run in the terminal:

`orbitdb create a eventlog`

Copy the address the above command output. Eg. /orbitdb/QmQxfgdjo3EQZiqBgt4uDiJNoLNedRNCZTHCquohxScsXc/a.

In a second terminal, run:

`mkdir tmp/ && cd tmp/ orbitdb replicate

 --progress

Eg. orbitdb replicate /orbitdb/QmQxfgdjo3EQZiqBgt4uDiJNoLNedRNCZTHCquohxScsXc/a --progress --dashboard

Output:`Replicating '/orbitdb/QmQxfgdjo3EQZiqBgt4uDiJNoLNedRNCZTHCquohxScsXc/a' ░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░░ 0/0 | 0.0% | 00:00:00`

In the first terminal, run:`orbitdb add

 hi! -r --sync --interval 1000


Observe the database replicating to the second instance.

Output:`Replicating ██████████████████████████░░░░░░░░░░░░░░ 2/3 | 66.7% | 00:00:21`

`Replicating ████████████████████████████████████████ 77/77 | 100.0% | 00:02:31`

`$3`

First, create a database and add an item to it:

`$ node src/bin.js create /orbitdb/mydocstore docstore ~ /orbitdb/QmapaF6FmS3JgTQBKSpSZUdqgf2t8VUUvXcUCdPd5MaeQB/orbitdb/mydocstore $ node src/bin.js put /orbitdb/QmapaF6FmS3JgTQBKSpSZUdqgf2t8VUUvXcUCdPd5MaeQB/orbitdb/mydocstore '{"name": "foo", "_id": 1}' --indexBy name Added document 'foo'`

You may now syncrhonise it with another. To do that, run replicate on the current directory as well as in the directory you want to synchronise with. Both should result in the same output:

`$ node src/bin.js replicate /orbitdb/QmapaF6FmS3JgTQBKSpSZUdqgf2t8VUUvXcUCdPd5MaeQB/orbitdb/mydocstore --progress Swarm listening on /ip4/127.0.0.1/tcp/38795/ipfs/QmRvDCjRzBB9PjkcCRJQFBDS8V8hsfivpQGFUh85ERxQeM Swarm listening on /ip4/1.2.3.4/tcp/38795/ipfs/QmRvDCjRzBB9PjkcCRJQFBDS8V8hsfivpQGFUh85ERxQeM Loading '/orbitdb/QmapaF6FmS3JgTQBKSpSZUdqgf2t8VUUvXcUCdPd5MaeQB/orbitdb/mydocstore' (docstore) Loading '/orbitdb/QmapaF6FmS3JgTQBKSpSZUdqgf2t8VUUvXcUCdPd5MaeQB/orbitdb/mydocstore' ░░░ 0/1 | 0.0% | 00:00:00 ████████████████████████████████████████████████████████████████████████████████████████ 1/1 | 100.0% | 00:00:00 Replicating '/orbitdb/QmapaF6FmS3JgTQBKSpSZUdqgf2t8VUUvXcUCdPd5MaeQB/orbitdb/mydocstore' ████████████████████████████████████████████████████████████████████████████████████████ 1/1 | 100.0% | 00:00:00`

`Dev`

Random notes

`node src/bin.js import 2017.csv /t9 src/schemas/csv-schema1.js --progress --limit 5000 --indexBy name``

License

MIT ©️ 2017 Haadcode

orbitdb - CLI for orbit-db

A CLI tool to manage orbit-db databases.

Quick Start

``$ orbitdb create hello feed /orbitdb/QmfSUsdr34iGio68eMezDzZLCKZTnbsxNJgiNipimZtpi1/hello

$ orbitdb add /orbitdb/QmfSUsdr34iGio68eMezDzZLCKZTnbsxNJgiNipimZtpi1/hello "world" Added QmSwYZheHVa3eWf83XwnWNJtjGG7EWjiWTaTKLeFozVRnz

$ orbitdb get /orbitdb/QmfSUsdr34iGio68eMezDzZLCKZTnbsxNJgiNipimZtpi1/hello "world"

$ orbitdb del /orbitdb/QmfSUsdr34iGio68eMezDzZLCKZTnbsxNJgiNipimZtpi1/hello QmSwYZheHVa3eWf83XwnWNJtjGG7EWjiWTaTKLeFozVRnz Deleted QmSwYZheHVa3eWf83XwnWNJtjGG7EWjiWTaTKLeFozVRnz

$ orbitdb get /orbitdb/QmfSUsdr34iGio68eMezDzZLCKZTnbsxNJgiNipimZtpi1/hello Database '/orbitdb/QmfSUsdr34iGio68eMezDzZLCKZTnbsxNJgiNipimZtpi1/hello' is empty!

`Requirements`

* Node.js >= v8.0.0 * npm

`Install`


From Npm:

`npm install -g orbit-db-cli`

From Git:

`git clone https://github.com/orbitdb/orbit-db-cli.git cd orbit-db-cli/ npm install`

`Run`

`orbitdb`

When installed from Git, the CLI can be run with node ./src/bin

For complete guide on usage, see the CLI help:

`orbitdb help`

Output:

`_ _ _ _ _ | | (_) | | | | ___ _ __| |__ _| |_ __| | |__ / _ \| '__| '_ \| | __| / _ | '_ \
| (_) | | | |_) | | |_ | (_| | |_) |
\___/|_| |_.__/|_|\__| \__,_|_.__/

Peer-to-Peer Database
https://github.com/orbitdb/orbit-db

Usage: orbitdb

Options:
-h, --help Show help [boolean]
``

`$3`

To use orbit-db with an existing IPFS data repository, set the IPFS_PATH environment variable to the desired IPFS repository path. Eg. run the CLI with IPFS_PATH=/path/to/ipfs orbitdb ...

`Demo`

`node ./src/cli/bin demo FRANK!`

Output:

`_ _ _ _ _ | | (_) | | | | ___ _ __| |__ _| |_ __| | |__ / _ \| '__| '_ \| | __| / _ | '_ \
| (_) | | | |_) | | |_ | (_| | |_) |
\___/|_| |_.__/|_|\__| \__,_|_.__/

Peer-to-Peer Database
https://github.com/orbitdb/orbit-db

> node "src/bin.js" create /orbitdb/demo docstore
/orbitdb/QmcE2HMrDTL3SFV1rcB5GaJVSJFfpFsnfTM4qK8SRScjyj/demo

> node "src/bin.js" put /orbitdb/QmcE2HMrDTL3SFV1rcB5GaJVSJFfpFsnfTM4qK8SRScjyj/demo "{\"_id\":1,\"name\":\"FRANK!\"}" --indexBy name
Added document 'FRANK!'

> node "src/bin.js" drop /orbitdb/QmcE2HMrDTL3SFV1rcB5GaJVSJFfpFsnfTM4qK8SRScjyj/demo yes
Dropped database '/orbitdb/QmcE2HMrDTL3SFV1rcB5GaJVSJFfpFsnfTM4qK8SRScjyj/demo'

Demo finished!
``

`Replicate`

`$3`

Demo:

Run in the terminal:

`orbitdb create a eventlog`

Copy the address the above command output. Eg. /orbitdb/QmQxfgdjo3EQZiqBgt4uDiJNoLNedRNCZTHCquohxScsXc/a.

In a second terminal, run:

`mkdir tmp/ && cd tmp/ orbitdb replicate

 --progress

Eg. orbitdb replicate /orbitdb/QmQxfgdjo3EQZiqBgt4uDiJNoLNedRNCZTHCquohxScsXc/a --progress --dashboard

In the first terminal, run:`orbitdb add

 hi! -r --sync --interval 1000


Observe the database replicating to the second instance.

Output:`Replicating ██████████████████████████░░░░░░░░░░░░░░ 2/3 | 66.7% | 00:00:21`

`Replicating ████████████████████████████████████████ 77/77 | 100.0% | 00:02:31`

`$3`

First, create a database and add an item to it:

You may now syncrhonise it with another. To do that, run replicate on the current directory as well as in the directory you want to synchronise with. Both should result in the same output:

`Dev`

Random notes

`node src/bin.js import 2017.csv /t9 src/schemas/csv-schema1.js --progress --limit 5000 --indexBy name``