Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

ipfs daemon command help lists --local as an option #1622

Closed
olizilla opened this issue Oct 7, 2018 · 3 comments
Closed

ipfs daemon command help lists --local as an option #1622

olizilla opened this issue Oct 7, 2018 · 3 comments
Assignees
Labels
exp/novice Someone with a little familiarity can pick up kind/support A question or request for support P3 Low: Not priority right now

Comments

@olizilla
Copy link
Member

olizilla commented Oct 7, 2018

  • Version: 0.32.3
  • Platform: All
  • Subsystem: CLI

Type: Bug

Severity: Low

Description:

Running jsifps daemon --help lists out a --local option which is a global flag for all the cli commands, but doesn't make sense to list as an option for the daemon command, as, I assume, it's ignored and it's defined as:

--local  Run the command locally, instead of using the daemon      

It might be fiddly, but this flag should be removed from the help output for the daemon command.

Steps to reproduce the error:

$ jsipfs daemon --help
jsipfs daemon

Start a long-running daemon process

Options:
  --version                     Show version number                    [boolean]
  --silent                      Write no output       [boolean] [default: false]
  --pass                        Pass phrase for the keys  [string] [default: ""]
  --local                       Run the command locally, instead of using the
                                daemon                [boolean] [default: false]
  --help                        Show help                              [boolean]
  --enable-sharding-experiment                        [boolean] [default: false]
  --enable-pubsub-experiment                          [boolean] [default: false]
  --enable-dht-experiment                             [boolean] [default: false]
@alanshaw alanshaw added kind/support A question or request for support exp/novice Someone with a little familiarity can pick up status/ready Ready to be worked P3 Low: Not priority right now labels Oct 17, 2018
@alanshaw
Copy link
Member

@vasco-santos would you be able to look into this? I think this is a "global" flag in go-ipfs and so was added as a global flag here in js-ipfs.

The problem is that in go-ipfs it doesn't seem to be listed for individual commands, even when it can be used whereas we have the opposite problem where it's always listed, even if it can't be used.

I think we should just remove it as a global flag and add it to the commands where it is relevant.

@vasco-santos
Copy link
Member

sure @alanshaw ! I will add to my stack and fix it sooner

@vasco-santos
Copy link
Member

I will add it to the daemon command, which is the only one where it makes sense, at least now. However, its documentation seems also improper

--local  Run the command locally, instead of using the daemon 

Regarding ipns, if the local flag is used in the daemon command, the ipns is started with an OfflineRouting, that is, using the local repo. On the other side, if the local flag is not used, the Routing used by ipns will be the DHT.

--local  Run commands locally to the daemon

Let me know if you have better ideas for the description of this option.

@ghost ghost assigned vasco-santos Oct 20, 2018
@ghost ghost added status/in-progress In progress and removed status/ready Ready to be worked labels Oct 20, 2018
@ghost ghost removed the status/in-progress In progress label Oct 30, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
exp/novice Someone with a little familiarity can pick up kind/support A question or request for support P3 Low: Not priority right now
Projects
None yet
Development

No branches or pull requests

3 participants