https://github.com/orvn/cidls

ls cli command, except with CID hashes for all files
https://github.com/orvn/cidls

Last synced: 12 days ago
JSON representation

ls cli command, except with CID hashes for all files

• Host: GitHub
• URL: https://github.com/orvn/cidls
• Owner: orvn
• License: apache-2.0
• Created: 2023-08-25T20:58:26.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-06T03:03:48.000Z (over 1 year ago)
• Last Synced: 2024-04-14T22:50:21.207Z (9 months ago)
• Language: Go
• Size: 32.9 MB
• Stars: 10
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# `cidls`

`ls`, but with CIDs.

A cli command similar to `ls`, except with CIDs computed for each file name alongside the output. The current implementation is functional, but in an MVP state.

## Quick install

Quickly install this cli command by running

```bash

curl -fsSL https://raw.githubusercontent.com/orvn/cidls/main/install.sh | sudo bash

```

That's it! OS detection is automatic and the binary will be moved to an executable path. You'll likely be prompted for a password.

## Usage

`cidls` `[path]` `[CID version]`

- Run the command like `cidls ~/some/path 0`

- The path is optional, default path is the current working directory

- The second argument accepts `0` for CID v0 or `1` for CID v1

### Flags

- `cidls -v` for version information

- `cidls -h` for help

(more flags to come for setting multihash and multicodec)

### Build from source

1. Clone this this repo

2. Compile from source with `go build`

3. Try it out by running `./cidls` for the current directory or `./cidls ~/some/path` to target any directory

#### todo

- Compile and test on different OSs (currently only tested on macOS)

- Add to path to run as cli command

- Support different types of CIDs

- Create a caching system to avoid re-processing files too much

- Make compatible with BSD-style `LSCOLORS` variable (e.g., `exgxcxdxbxegedabagacad`)

- Add options for a few common ls flags