Metadata-Version: 2.4
Name: open-aea-cli-ipfs
Version: 2.2.6
Summary: CLI extension for open AEA framework wrapping IPFS functionality.
Author: Valory AG
License: Apache-2.0
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Communications
Classifier: Topic :: Internet
Classifier: Topic :: Software Development
Requires-Python: >=3.10,<3.15
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: open-aea<3.0.0,>=2.0.0
Requires-Dist: click<8.4.0,>=8.1.0
Provides-Extra: test-tools
Requires-Dist: pytest<10,>=7.0; extra == "test-tools"
Dynamic: author
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: license
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# AEA CLI IPFS Plug-in

IPFS command to publish and download directories.

## Installation and usage

Make sure you have `aea` installed.

Then, install the plug-in:
``` bash
pip install aea-cli-ipfs
```

Now you should be able to run `aea ipfs`.

``` bash
Usage: aea ipfs [OPTIONS] COMMAND [ARGS]...

  IPFS Commands

Options:
  --help  Show this message and exit.

Commands:
  add       Add directory to ipfs, if not directory specified the current...
  download  Download directory by it's hash, if not target directory...
  remove    Remove a directory from ipfs by it's hash.



Usage: aea ipfs add [OPTIONS] [DIR_PATH]

  Add directory to ipfs, if not directory specified the current one will be
  added.

Options:
  -p, --publish
  --help         Show this message and exit.



Usage: aea ipfs remove [OPTIONS] hash_id

  Remove a directory from ipfs by it's hash.

Options:
  --help  Show this message and exit.



Usage: aea ipfs download [OPTIONS] hash_id [TARGET_DIR]

  Download directory by it's hash, if not target directory specified will
  use current one.

Options:
  --help  Show this message and exit.

```
