diff --git a/README.md b/README.md index 9cb6ca53..5ad3b0af 100644 --- a/README.md +++ b/README.md @@ -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 https://atlascity.io diff --git a/doc/articles/csipfs.md b/doc/articles/csipfs.md new file mode 100644 index 00000000..3ca0941e --- /dev/null +++ b/doc/articles/csipfs.md @@ -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 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. +``` diff --git a/doc/articles/intro.md b/doc/articles/intro.md index 3b095222..8d964151 100644 --- a/doc/articles/intro.md +++ b/doc/articles/intro.md @@ -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 diff --git a/doc/articles/toc.yml b/doc/articles/toc.yml index f97c188c..aeb66da0 100644 --- a/doc/articles/toc.yml +++ b/doc/articles/toc.yml @@ -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