Skip to content

Commit f79cd35

Browse files
committed
add license & update docs
1 parent 08b67ec commit f79cd35

3 files changed

Lines changed: 56 additions & 6 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Rilomilo
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
11
# docker-image-cli
22

3-
A command-line tool for searching Docker Hub, inspecting image metadata, and downloading images as tar files — without needing Docker installed.
3+
[![npm version](https://img.shields.io/npm/v/docker-image-cli.svg)](https://www.npmjs.com/package/docker-image-cli)
4+
[![npm downloads](https://img.shields.io/npm/dm/docker-image-cli.svg)](https://www.npmjs.com/package/docker-image-cli)
5+
[![license](https://img.shields.io/npm/l/docker-image-cli.svg)](LICENSE)
6+
7+
**Search, inspect, audit, and fast download Docker images — without installing Docker.**
8+
9+
10+
https://github.com/user-attachments/assets/b28cf71e-539d-4596-a894-33739f1981fa
11+
412

513
## Features
614

715
- **Search** Docker Hub and display stars, pull counts, and official status
8-
- **List tags** with compressed size and last-updated date (via Docker Hub API)
16+
- **List tags** with compressed size and last-updated date
917
- **Inspect** image config: platform, environment, entrypoint, ports, layers, and build history
10-
- **Pull** images as `docker load`-compatible tar files, with **concurrent layer downloads** and live progress
11-
12-
Works with Docker Hub and any registry that speaks the [OCI Distribution Spec](https://github.com/opencontainers/distribution-spec) (Docker Registry HTTP API v2).
18+
- **Pull** images as `docker load`-compatible tars with **concurrent layer downloads** and live progress
19+
20+
- Works with Docker Hub and any registry that speaks the [OCI Distribution Spec](https://github.com/opencontainers/distribution-spec) (Docker Registry HTTP API v2).
1321

1422
---
1523

@@ -30,7 +38,7 @@ docker-img <command> [options]
3038
For local development, clone the repo and link it:
3139

3240
```bash
33-
git clone https://github.com/your-username/docker-image-cli.git
41+
git clone https://github.com/Rilomilo/docker-image-cli.git
3442
cd docker-image-cli
3543
npm install
3644
npm link

package.json

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,27 @@
22
"name": "docker-image-cli",
33
"version": "1.0.5",
44
"description": "CLI tool for querying Docker image metadata and downloading images",
5+
"license": "MIT",
6+
"keywords": [
7+
"docker",
8+
"docker-image",
9+
"docker-hub",
10+
"docker-registry",
11+
"docker-pull",
12+
"docker-load",
13+
"oci",
14+
"oci-image",
15+
"container",
16+
"container-image",
17+
"registry",
18+
"manifest",
19+
"image-inspect",
20+
"image-download",
21+
"no-docker",
22+
"air-gapped",
23+
"ghcr",
24+
"cli"
25+
],
526
"repository": {
627
"type": "git",
728
"url": "git+https://github.com/Rilomilo/docker-image-cli.git"

0 commit comments

Comments
 (0)