helia-cli

Run helia as a daemon process

Table of contents

• Structure
• Project status
• Name
• Background
• Roadmap
• API Docs
• License
• Contribute

Structure

• /packages/cli-utils Common code for Helia CLI tools
• /packages/helia-cli Run a Helia node on the cli
• /packages/rpc-client An implementation of IPFS in JavaScript
• /packages/rpc-protocol RPC protocol for use by @helia/rpc-client and @helia/rpc-server
• /packages/rpc-server An implementation of IPFS in JavaScript
• /packages/unixfs-cli Run unixfs commands against a Helia node on the CLI

Project status

This project is pre-alpha and is currently in development. An initial v1 release is planned for late Q1 2023. Helia is being built in the open; community contributors are welcome!

The core of IPFS is the Files API, which will likewise be implemented in Helia. These initial building blocks are in development now; have a look at this repo's PR(s). For more info about Helia, please see the Roadmap and the Manifesto.

We are also sharing about the progress so far, and discussing how you can get involved, at Helia Demo Day every couple weeks. We'd love to see you there!

Name

Helia (HEE-lee-ah) is the Latin spelling of Ἡλιη -- in Greek mythology, one of the Heliades: the daughters of the sun god Helios. When their brother Phaethon died trying to drive the sun chariot across the sky, their tears of mourning fell to earth as amber, which is yellow (sort of), and so is JavaScript. They were then turned into poplar trees and, well, JavaScript is quite popular.

In Oct–Dec 2022, IP Stewards sought community input for the name of this project. After considering 20 suggestions and holding a couple of polls, the name Helia was chosen. Here's why it's not named IPFS.

Background

This project aims to build a lean, modular, and modern implementation of IPFS, the Interplanetary File System.

For more information, see the State of IPFS in JS (blog post).

Roadmap

Please find and comment on the Roadmap here.

This IPFS implementation in JavaScript is a work in progress. Here are some ways you can help!

API Docs

• https://ipfs.github.io/helia-cli

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribute

Contributions welcome! Please check out the issues.

Also see our contributing document 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.

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.