kubo icon indicating copy to clipboard operation
kubo copied to clipboard

Create `ipfs repo ls` alias for `ipfs refs local`

Open Winterhuman opened this issue 3 years ago • 7 comments

Checklist

  • [X] My issue is specific & actionable.
  • [X] I am not suggesting a protocol enhancement.
  • [X] I have searched on the issue tracker for my issue.

Description

Users wanting to list all objects in their repo need to run ipfs refs local, however, most users look under ipfs repo because of it's name; ipfs refs isn't intuitively located. Additionally, ipfs refs only has one subcommand which doesn't feel necessary.

So, I've opened this issue to discuss. I propose ipfs repo refs, with ipfs refs local becoming ipfs repo refs -l/--local.

Winterhuman avatar Aug 17 '22 21:08 Winterhuman

I am not in favor of moving all of ipfs refs, just ipfs refs local => ipfs repo ls.

Jorropo avatar Aug 17 '22 21:08 Jorropo

That could work as well, an alias would be a lot easier than removing ipfs refs (and it would be more backwards compatible as well)

Winterhuman avatar Aug 17 '22 21:08 Winterhuman

After looking at ipfs refs's functionality closer, moving the whole thing under ipfs repo would make no sense. I think Jorropo's idea is the best moving forward

Winterhuman avatar Aug 25 '22 19:08 Winterhuman

2022-08-26 triage conversation: add an alias from ipfs repo lsipfs refs local.

BigLep avatar Aug 26 '22 15:08 BigLep

@Winterhuman : do you want to take this one?

BigLep avatar Aug 26 '22 15:08 BigLep

@BigLep I wouldn't have a clue unfortunately

Winterhuman avatar Aug 26 '22 15:08 Winterhuman

@BigLep I'm giving it a try. I'll ping you for review of my pr.

Zanda256 avatar Sep 07 '22 06:09 Zanda256

@BigLep @Jorropo https://github.com/ipfs/kubo/pull/9320 Do you think this is good enough for the alias? Or am I breaking any code rules?

Thank you

susarlanikhilesh avatar Oct 01 '22 07:10 susarlanikhilesh

https://github.com/ipfs/kubo/pull/9320 is now merged, closing issue. Thanks @susarlanikhilesh!

Winterhuman avatar Oct 15 '22 19:10 Winterhuman