Skip to content
This repository has been archived by the owner on Dec 18, 2023. It is now read-only.

document all CLI commands, arguments, and flags planned for v0.1.0 release #165

Closed
10 tasks done
Tracked by #168
b5 opened this issue Oct 5, 2022 · 3 comments
Closed
10 tasks done
Tracked by #168
Assignees

Comments

@b5
Copy link
Member

b5 commented Oct 5, 2022

Tracking issue prepare language engineers can copy-paste into PRs for each command. audit short flags for consistency where possible.

Each command needs:

  • about string (short, one line description)
  • description string for each argument
  • description string for each flag
  • after_help string (long form description of command)

Command documentation checklist

@b5 b5 self-assigned this Oct 5, 2022
@faassen faassen mentioned this issue Feb 17, 2023
20 tasks
@b5
Copy link
Member Author

b5 commented Oct 6, 2022

iroh p2p help text:

iroh-p2p
Peer-2-peer commands

USAGE:
    iroh p2p <SUBCOMMAND>

OPTIONS:
    -h, --help    Print help information

SUBCOMMANDS:
    connect    Connect to a peer
    help       Print this message or the help of the given subcommand(s)
    lookup     Retrieve info about a peer


p2p commands all relate to peer-2-peer connectivity. See subcommands for
additional details.

@b5
Copy link
Member Author

b5 commented Oct 8, 2022

iroh p2p connect help text:

> iroh p2p connect --help
iroh-p2p-connect
Connect to a peer

USAGE:
    iroh p2p connect <addr>...

ARGS:
    <addr>...    Multiaddr or peer ID of a peer to connect to

OPTIONS:
    -h, --help    Print help information


Attempts to open a new direct connection to a peer address. By default p2p
continulously maintains an open set of peer connections based on requests &
internal hueristics. Connect is useful in situations where it makes sense to
manually force libp2p to dial a known peer. A common example includes when you
know the multiaddr or peer ID of a peer that you would like to exchange data
with.

The address format is in multiaddr format. For example:

  > iroh p2p connect /ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ

for more info on multiaddrs see https://iroh.computer/docs/concepts#multiaddr

If a peer ID is provided, connect first perform a distribtued hash table (DHT)
lookup to learn the address of the given peer ID before dialing.

@b5
Copy link
Member Author

b5 commented Oct 8, 2022

iroh help text:

> iroh --help
iroh
A next generation IPFS implementation: https://iroh.computer

USAGE:
    iroh <SUBCOMMAND>

OPTIONS:
    -h, --help       Print help information
    -v, --version    print iroh version information

SUBCOMMANDS:
    add       Add a file to iroh & make it available on IPFS
    get       Fetch IPFS content and write it to disk
    help      Print this message or the help of the given subcommand(s)
    p2p       Peer-2-peer commands
    start     Start iroh daemon(s)
    status    Report current status of iroh
    stop      Stop iroh daemon(s)


Iroh is a next-generation implementation the Interplanetary File System (IPFS).
IPFS is a networking protocol for exchanging content-addressed blocks of
immutable data. 'content-addressed' means referring to data by the hash of it's
content, which makes the reference both unique and verifiable. These two
properties make it possible to get data from any node in the network that speaks
the IPFS protocol, including IPFS content being served by other implementations
of the protocol.

For more info see https://iroh.computer/docs

@b5 b5 closed this as completed Oct 8, 2022
@b5 b5 mentioned this issue Feb 17, 2023
4 tasks
@dignifiedquire dignifiedquire transferred this issue from n0-computer/iroh Feb 17, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

1 participant