INFINIT CLI - Alpha Release

Overview

Welcome to the INFINIT CLI, a powerful command-line tool designed to interact with the INFINIT Library. This project is currently in Alpha Release, so features and interfaces are subject to change. We appreciate any feedback and contributions to help improve the project.

Getting Started

To get started, follow the instructions below to install dependencies, build the CLI, and test it locally.

Installation

To install the necessary dependencies, run the following command:

bun install

Building the CLI

After installing dependencies, you can build the CLI by running:

bun run build

This will compile the project and make it ready for local testing and development.

Local Testing

To test the CLI locally, follow these steps to create a new Node.js project and link the CLI package to your local environment.

Step 1: Link the Local Package

First, link the local build of the CLI to your environment:

bun link

Step 2: Create a New Project

Next, create a new project outside of the @infinit-xyz/cli directory:

bun init -y

Step 3: Link the CLI Package

Once your new project is initialized, link the INFINIT CLI package to the project:

bun link @infinit-xyz/cli

You can now run the CLI commands from within your new project directory.

Contributing

We welcome contributions! If you are interested in contributing to the INFINIT CLI, please refer to the guidelines in the CONTRIBUTING.md file for instructions on how to get involved.

Support & Feedback

If you encounter any issues or have feedback regarding the INFINIT CLI, feel free to open an issue on our GitHub repository or join the discussion with our community, Discord | X.