Browse Source

Cli docs (#58)

* Adding in the CLI reference

Signed-off-by: Mary Anthony <mary@blockstack.com>

* Adding in the cli reference

Signed-off-by: Mary Anthony <mary@blockstack.com>
feat/clarity-updates
Moxiegirl 6 years ago
committed by GitHub
parent
commit
846ec265ec
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 7
      _core/cmdLineRef.md
  2. 1259
      _data/cliRef.json
  3. 4
      _data/navigation_core.yml
  4. 1
      _data/navigation_learn.yml
  5. 7
      _develop/cliDocs.md
  6. 95
      _includes/commandline.md

7
_core/cmdLineRef.md

@ -0,0 +1,7 @@
---
layout: core
permalink: /:collection/:path.html
---
# blockstack_cli reference
{% include commandline.md %}

1259
_data/cliRef.json

File diff suppressed because it is too large

4
_data/navigation_core.yml

@ -9,7 +9,7 @@
docs: docs:
- core/naming/tutorial_subdomains - core/naming/tutorial_subdomains
- core/naming/search - core/naming/search
- core/faq_technical
- title: How to use BNS - title: How to use BNS
docs: docs:
@ -29,7 +29,7 @@
- title: Reference - title: Reference
docs: docs:
- core/cmdLineRef
- common/javascript_ref - common/javascript_ref
- common/core_ref - common/core_ref
- core/wire-format - core/wire-format
- core/faq_technical

1
_data/navigation_learn.yml

@ -32,4 +32,5 @@
- title: Reference - title: Reference
docs: docs:
- common/javascript_ref - common/javascript_ref
- develop/cliDocs
- common/core_ref - common/core_ref

7
_develop/cliDocs.md

@ -0,0 +1,7 @@
---
layout: learn
permalink: /:collection/:path.html
---
# blockstack_cli reference
{% include commandline.md %}

95
_includes/commandline.md

@ -0,0 +1,95 @@
The command line is intended for developers only. Developers can use the command
line to test and debug Blockstack applications in ways that the Blockstack
Browser does not yet support. Using the command line, developers can:
* Generate and Broadcast all supported types of Blockstack transactions
* Load, store, and list data in Gaia hubs
* Generate owner, payment and application keys from a seed phrase
* Query Blockstack core nodes
* Implement a minimum viable authentication flow
{% include warning.html content="Many of the commands operate on unencrypted
private keys. For this reason, DO NOT use this tool for day-to-day tasks as you
risk the security of your keys." %}
You must <a href="#installCommandLine">install the command line</a> before you
can use the commands
## List of commands
{:.no_toc}
* TOC
{:toc}
{% for entry in site.data.cliRef %}
## {{ entry.command }}
**Group**: {{ entry.group }}
{{ entry.usage }}
### Arguments
{:.no_toc}
<table class="uk-table uk-table-small uk-table-striped">
<tr>
<th>Name</th>
<th>Type</th>
<th>Value</th>
<th>Format</th>
</tr>
{% for arg in entry.args %}
<tr>
<td class="uk-text-bold">{{ arg.name }}</td>
<td>{{ arg.type }}</td>
<td>{{ arg.value }}</td>
<td><code style="font-size:10px">{{ arg.format }}</code></td>
</tr>
{% endfor %}
</table>
{% endfor %}
<p><a name="installCommandLine">&nbsp;</a></p>
## How to install the command line
{:.no_toc}
These instructions assume you are using a macOS or Linux system. Installing the
command line relies on the `npm` dependency manager and optionally Git. If you
don't find `npm` in your system, <a href="https://www.npmjs.com/get-npm"
target="\_blank">install it</a>.
To install the command line:
1. <a href="https://github.com/blockstack/cli-blockstack" target="\_blank">Download or `git clone` the command line repository code</a>.
Downloading or cloning the repo creates a `cli-blockstack` repository on your system.
2. Change directory into the `cli-blockstack` directory.
```
cd cli-blockstack
```
3. Install the dependencies with `npm`.
```
npm install
```
4. Build the command line command.
```
npm run build
```
5. Link the command.
```
sudo npm link
```
Loading…
Cancel
Save