View Source MyspaceIPFS.Commands (Myspace IPFS v0.2.0-alpha.1)

MyspaceIPFS.Commands is where the commands commands of the IPFS API reside.

Link to this section Summary

Types

A struct that represents a command object.

Functions

Generate command autocompletion script.

Link to this section Types

@type command() :: %MyspaceIPFS.CommandsCommand{
  name: binary(),
  options: list(),
  subcommands: list()
}

A struct that represents a command object.

Link to this section Functions

@spec commands() :: {:ok, any()} | MyspaceIPFS.Api.error_response()

List all available commands. https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-commands

@spec completion(binary()) :: {:ok, any()} | MyspaceIPFS.Api.error_response()

Generate command autocompletion script.

NB! These completions aren't actually in the API, but are generated by the client. This requires shell access to the client machine. If you want shell completions, you should install the IPFS CLI and use its completions.

parameters

Parameters

https://docs.ipfs.tech/reference/kubo/rpc/#api-v0-commands-completion shell - The shell to generate the autocompletion script for. Currently bash and fish are supported.