Skip to content

Wrong --local/-L flag documentation #4182

@ghost

Description

Version information: v0.4.10

Type: bug

Severity: medium

Description:

ipfs --help defines --local as "Run the command locally, instead of using the daemon". This is completely inaccurate. The flag is used in only two places:

  • ipfs add --local uses an Offline Exchange for adding files, skipping the immediate publication of provider records.
  • ipfs name resolve --local uses an Offline Routing Resolver, avoiding IPNS queries to the DHT.

The flag should be removed from the root command, and instead added to these two commands.

There's a backward compatiblity angle to consider, where tools could possibly be calling ipfs --local add <file> instead of the better ipfs add --local <file>.

Metadata

Metadata

Assignees

No one assigned

    Labels

    kind/bugA bug in existing code (including security flaws)topic/commandsTopic commandstopic/commands:addTopic commands:add

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions