Skip to content

Commit

Permalink
Add a barebones readme to the car CLI (#262)
Browse files Browse the repository at this point in the history
  • Loading branch information
willscott authored Nov 1, 2021
1 parent f5fe6d6 commit 85f0751
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ go-car (go!)

[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)
[![](https://img.shields.io/badge/project-ipld-orange.svg?style=flat-square)](https://github.com/ipld/ipld)
[![](https://img.shields.io/badge/freenode-%23ipld-orange.svg?style=flat-square)](https://webchat.freenode.net/?channels=%23ipld)
[![](https://img.shields.io/badge/matrix-%23ipld-blue.svg?style=flat-square)](https://matrix.to/#/#ipld:ipfs.io)
[![Go Reference](https://pkg.go.dev/badge/github.com/ipld/go-car.svg)](https://pkg.go.dev/github.com/ipld/go-car)
[![Coverage Status](https://codecov.io/gh/ipld/go-car/branch/master/graph/badge.svg)](https://codecov.io/gh/ipld/go-car/branch/master)

Expand Down
33 changes: 33 additions & 0 deletions cmd/car/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
car - The CLI tool
==================

[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](https://protocol.ai)
[![](https://img.shields.io/badge/project-ipld-orange.svg?style=flat-square)](https://github.com/ipld/ipld)
[![](https://img.shields.io/badge/matrix-%23ipld-blue.svg?style=flat-square)](https://matrix.to/#/#ipld:ipfs.io)

> A CLI to interact with car files
## Usage

```
USAGE:
car [global options] command [command options] [arguments...]
COMMANDS:
create, c Create a car file
detach-index Detach an index to a detached file
filter, f Filter the CIDs in a car
get-block, gb Get a block out of a car
get-dag, gd Get a dag out of a car
index, i write out the car with an index
list, l List the CIDs in a car
verify, v Verify a CAR is wellformed
help, h Shows a list of commands or help for one command
```

## Install

To install the latest version of `car` module, run:
```shell script
go install github.com/ipld/go-car/cmd/car
```

0 comments on commit 85f0751

Please sign in to comment.