Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: moved CLI docs to new reference section

Browse Source
This commit is contained in:
troymc 2016-08-08 15:56:30 +02:00
parent 95db652a58
commit 6c81882899
5 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/source/nodes/index.rst
View File

@ -12,4 +12,3 @@ BigchainDB Nodes
setup-run-node setup-run-node
run-with-docker run-with-docker
running-unit-tests running-unit-tests
bigchaindb-cli

2
docs/source/nodes/run-with-docker.md
View File

@ -96,7 +96,7 @@ docker run --rm -v "$HOME/bigchaindb_docker:/data" -ti \
Note the `--link` option to link to the first container (named `bigchaindb`). Note the `--link` option to link to the first container (named `bigchaindb`).
Aside: The `bigchaindb load` command has several options (e.g. `-m`). You can read more about it in [the documentation about the BigchainDB command line interface](bigchaindb-cli.html). Aside: The `bigchaindb load` command has several options (e.g. `-m`). You can read more about it in [the documentation about the BigchainDB command line interface](../server-reference/bigchaindb-cli.html).
If you look at the RethinkDB dashboard (in your web browser), you should see the effects of the load test. You can also see some effects in the Docker logs using: If you look at the RethinkDB dashboard (in your web browser), you should see the effects of the load test. You can also see some effects in the Docker logs using:
```text ```text

2
docs/source/nodes/setup-run-node.md
View File

@ -161,7 +161,7 @@ Start by creating a default BigchainDB config file:
bigchaindb -y configure bigchaindb -y configure
``` ```
(There's documentation for the `bigchaindb` command is in the section on [the BigchainDB Command Line Interface (CLI)](bigchaindb-cli.html).) (There's documentation for the `bigchaindb` command in the section on [the BigchainDB Command Line Interface (CLI)](../server-reference/bigchaindb-cli.html).)
Edit the created config file: Edit the created config file:

5
docs/source/nodes/bigchaindb-cli.md → docs/source/server-reference/bigchaindb-cli.md
View File

@ -1,4 +1,7 @@
# The BigchainDB Command Line Interface (CLI) # BigchainDB Command Line Interface (CLI)
**Note: At the time of writing, BigchainDB Server and our BigchainDB client are combined, so the BigchainDB CLI includes some server-specific commands and some client-specific commands (e.g. `bigchaindb load`). Soon, BigchainDB Server will be separate from all BigchainDB clients, and they'll all have different CLIs.**
The command-line command to interact with BigchainDB is `bigchaindb`. The command-line command to interact with BigchainDB is `bigchaindb`.

3
docs/source/server-reference/index.rst
View File

@ -1,10 +1,11 @@
.. You can adapt this file completely to your liking, but it should at least .. You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
BigchainDB Server Reference BigchainDB Settings and CLI
=========================== ===========================
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
configuration configuration
bigchaindb-cli