Skip to content

Commit

Permalink
docs: improve
Browse files Browse the repository at this point in the history
  • Loading branch information
richardschneider committed Aug 16, 2019
1 parent 692179a commit b56849c
Show file tree
Hide file tree
Showing 4 changed files with 71 additions and 7 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,11 @@ string text = await ipfs.FileSystem.ReadAllTextAsync(filename);

## Related projects

- [IPFS Core](https://github.com/richardschneider/net-ipfs-core)
- [IPFS HTTP Client](https://github.com/richardschneider/net-ipfs-http-client)
- [IPFS HTTP Gateway](https://github.com/richardschneider/net-ipfs-http-gateway)
- [Peer Talk](https://github.com/richardschneider/peer-talk)
- [IPFS Core](https://github.com/richardschneider/net-ipfs-core) - Core IPFS objects and interfaces.
- [IPFS DSL](https://github.com/cloveekprojeqt/ipfs-dsl) - A declarative embedded language for building compositional programs and protocols over the InterPlanetary File System.
- [IPFS HTTP Client](https://github.com/richardschneider/net-ipfs-http-client) - A .Net client library for the IPFS HTTP API.
- [IPFS HTTP Gateway](https://github.com/richardschneider/net-ipfs-http-gateway) - Serves IPFS files/directories via HTTP.
- [Peer Talk](https://github.com/richardschneider/peer-talk) - Peer to peer communication.

## Sponsors
<img src="doc/images/atlascity.io-logo.png" width="200" alt="https://atlascity.io" />
Expand Down
59 changes: 59 additions & 0 deletions doc/articles/csipfs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# IPFS CLI

## Install

The `csipfs` tool is available on [Nuget](https://www.nuget.org/packages/csipfs/) and
is installed with dotnet.

> dotnet tool install --global csipfs

## Usage

`csipfs` is a tool to control your IPFS node.

```
> csipfs --help
Usage: csipfs [options] [command]
Options:
--version Show version information
--help Show help information
--api <url> Use a specific API instance
-L|--local Run the command locally, instead of using the daemon
--enc The output type (json, xml, or text)
--debug Show debugging info
--trace Show tracing info
--time Show how long the command took
Commands:
add Add a file to IPFS
bitswap Manage swapped blocks
block Manage raw blocks
bootstrap Manage bootstrap peers
cat Show IPFS file data
config Manage the configuration
daemon Start a long running IPFS deamon
dht Query the DHT for values or peers
dns Resolve DNS link
files Manage the mfs (Mutable File System) [WIP]
get Download IPFS data
id Show info on an IPFS peer
init Initialize ipfs local configuration [WIP]
key Manage private keys
ls List links
name Manage IPNS names
object Manage IPFS objects
pin Manage data in local storage [WIP]
pubsub Publish/subscribe to messages on a given topic
refs List hashes of links [WIP]
repo Manage the IPFS repository
resolve Resolve any type of name
shutdown Stop the IPFS deamon
stats Query IPFS statistics
swarm Manage connections to the p2p network
update Download the latest version [WIP]
version Show version information
Run 'csipfs [command] --help' for more information about a command.
```
8 changes: 5 additions & 3 deletions doc/articles/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,11 @@ package is published on [NuGet](https://www.nuget.org/packages/Ipfs.Engine).

## Related projects

- [IPFS Core](https://github.com/richardschneider/net-ipfs-core)
- [IPFS HTTP Client](https://github.com/richardschneider/net-ipfs-http-client)
- [Peer Talk](https://github.com/richardschneider/peer-talk)
- [IPFS Core](https://github.com/richardschneider/net-ipfs-core) - Core IPFS objects and interfaces.
- [IPFS DSL](https://github.com/cloveekprojeqt/ipfs-dsl) - A declarative embedded language for building compositional programs and protocols over the InterPlanetary File System.
- [IPFS HTTP Client](https://github.com/richardschneider/net-ipfs-http-client) - A .Net client library for the IPFS HTTP API.
- [IPFS HTTP Gateway](https://github.com/richardschneider/net-ipfs-http-gateway) - Serves IPFS files/directories via HTTP.
- [Peer Talk](https://github.com/richardschneider/peer-talk) - Peer to peer communication.

## Other implementations

Expand Down
2 changes: 2 additions & 0 deletions doc/articles/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
href: intro-ipfs.md
- name: Questions
href: questions.md
- name: IPFS command line
href: csipfs.md
- name: Features
href: core-api.md
- name: File System
Expand Down

0 comments on commit b56849c

Please sign in to comment.