# ipfs-cli

> JavaScript implementation of the IPFS specification

Latest version **0.16.1** (published 2023-05-25) · Apache-2.0 OR MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install ipfs-cli
pnpm add ipfs-cli
yarn add ipfs-cli
bun add ipfs-cli
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.16.1 |
| Published | 2023-05-25 |
| First published | 2020-05-14 |
| Weekly downloads | 0 |
| License | Apache-2.0 OR MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Node | >=16.0.0 |
| Dependencies | 30 |
| Unpacked size | 268.1 KB |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 7392 |
| Maintainers | achingbrain, ipfs-npm-publisher-bot, npm-service-account-ipfs |
| Keywords | IPFS |

## Links

- npm: https://www.npmjs.com/package/ipfs-cli
- Repository: https://github.com/ipfs/js-ipfs
- Homepage: https://github.com/ipfs/js-ipfs/tree/master/packages/ipfs-cli#readme
- Issues: https://github.com/ipfs/js-ipfs/issues
- npm.io page: https://npm.io/package/ipfs-cli

## Dependencies (30)

- [execa](https://npm.io/package/execa.md) ^6.1.0
- [yargs](https://npm.io/package/yargs.md) ^17.4.0
- [it-tar](https://npm.io/package/it-tar.md) ^6.0.0
- [byteman](https://npm.io/package/byteman.md) ^1.3.5
- [it-pipe](https://npm.io/package/it-pipe.md) ^2.0.3
- [it-merge](https://npm.io/package/it-merge.md) ^2.0.0
- [it-split](https://npm.io/package/it-split.md) ^2.0.0
- [progress](https://npm.io/package/progress.md) ^2.0.3
- [ipfs-core](https://npm.io/package/ipfs-core.md) ^0.18.1
- [it-concat](https://npm.io/package/it-concat.md) ^3.0.1
- [ipfs-utils](https://npm.io/package/ipfs-utils.md) ^9.0.13
- [ipfs-daemon](https://npm.io/package/ipfs-daemon.md) ^0.16.1
- [uint8arrays](https://npm.io/package/uint8arrays.md) ^4.0.2
- [@ipld/dag-pb](https://npm.io/package/@ipld/dag-pb.md) ^4.0.0
- [multiformats](https://npm.io/package/multiformats.md) ^11.0.0
- [pretty-bytes](https://npm.io/package/pretty-bytes.md) ^6.0.0
- [stream-to-it](https://npm.io/package/stream-to-it.md) ^0.2.2
- [jsondiffpatch](https://npm.io/package/jsondiffpatch.md) ^0.4.1
- [@ipld/dag-cbor](https://npm.io/package/@ipld/dag-cbor.md) ^9.0.0
- [@ipld/dag-json](https://npm.io/package/@ipld/dag-json.md) ^10.0.0
- [@libp2p/logger](https://npm.io/package/@libp2p/logger.md) ^2.0.5
- [parse-duration](https://npm.io/package/parse-duration.md) ^1.0.0
- [@libp2p/peer-id](https://npm.io/package/@libp2p/peer-id.md) ^2.0.0
- [get-folder-size](https://npm.io/package/get-folder-size.md) ^4.0.0
- [ipfs-core-types](https://npm.io/package/ipfs-core-types.md) ^0.14.1
- [ipfs-core-utils](https://npm.io/package/ipfs-core-utils.md) ^0.18.1
- [ipfs-http-client](https://npm.io/package/ipfs-http-client.md) ^60.0.1
- [@multiformats/mafmt](https://npm.io/package/@multiformats/mafmt.md) ^11.0.2
- [@multiformats/multiaddr](https://npm.io/package/@multiformats/multiaddr.md) ^11.1.5
- [@multiformats/multiaddr-to-uri](https://npm.io/package/@multiformats/multiaddr-to-uri.md) ^9.0.1

## Recent versions

- 0.16.1 (latest) — 2023-05-25
- 0.16.0-7b79c1b8 (next) — 2023-05-25
- 0.16.0-6d95ce08 — 2023-05-25
- 0.16.0-4694e806 — 2023-05-25
- 0.16.0-e64813f6 — 2023-05-24
- 0.16.0-b64d4af0 — 2023-02-01
- 0.16.0-3bcabe38 — 2023-01-17
- 0.16.0-ab02e8f8 — 2023-01-17
- 0.16.0-6eeb1be5 — 2023-01-13
- 0.16.0 — 2023-01-12
- 0.15.0-d1c3abb3 — 2023-01-11
- 0.15.0-fa578bac — 2023-01-11
- 0.15.0-789ee585 — 2023-01-11
- 0.15.0-4b4c124c — 2023-01-11
- 0.15.0-5f73ecad — 2023-01-10
- … 260 more at https://npm.io/package/ipfs-cli/versions

## README

> # ⛔️ DEPRECATED: [js-IPFS](https://github.com/ipfs/js-ipfs) has been superseded by [Helia](https://github.com/ipfs/helia)
>
> 📚 [Learn more about this deprecation](https://github.com/ipfs/js-ipfs/issues/4336) or [how to migrate](https://github.com/ipfs/helia/wiki/Migrating-from-js-IPFS)
>
> ⚠️ If you continue using this repo, please note that security fixes will not be provided

# ipfs-cli <!-- omit in toc -->

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-ipfs.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-ipfs)
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-ipfs/test.yml?branch=master\&style=flat-square)](https://github.com/ipfs/js-ipfs/actions/workflows/test.yml?query=branch%3Amaster)

> JavaScript implementation of the IPFS specification

## Table of contents <!-- omit in toc -->

- [Install](#install)
- [License](#license)
- [Contribute](#contribute)

## Install

```console
$ npm i ipfs-cli
```

```console
$ npm install -g ipfs
// npm install output
$ jsipfs daemon
```

## License

Licensed under either of

- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)

## Contribute

Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-ipfs/issues).

Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

---
_Source: https://npm.io/package/ipfs-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
