Skip to content

Commit

Permalink
add README
Browse files Browse the repository at this point in the history
Signed-off-by: Johnson Shi <Johnson.Shi@microsoft.com>
  • Loading branch information
johnsonshi committed Jul 22, 2022
1 parent aa12972 commit 9d79ee9
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# ORAS Tools

Helper tools for [ORAS](https://oras.land).

## Quick Start

### Install

To install, run the following commands.

```bash
curl -LO https://github.com/johnsonshi/oras-tools/releases/download/v0.0.1/oras-tools
chmod +x oras-tools
sudo mv oras-tools /usr/local/bin
```

## Commands

### Delete

Delete [ORAS artifacts](https://oras.land/#how-oras-works) from a registry.

To delete an ORAS artifact (referenced by its hash `$digest`) in `$registry_url` and `$repository_name`:

```bash
./bin/oras-tools delete \
--username "$registry_username" \
--password "$registry_password" \
--registry "$registry_url" \
--repository "$repository_name" \
--digest "$digest"
```

0 comments on commit 9d79ee9

Please sign in to comment.