Getting Started

Before you can push your first permanent repository, you need to set up your local environment and install the Permagit command-line interface (CLI).

1. Prerequisites

Make sure you have the following software installed on your system.

• Git: Permagit is a wrapper around your existing Git workflow. You must have Git installed.

  • Verify installation: git --version

• Node.js & npm: The Permagit CLI is distributed as an npm package. We recommend using the latest LTS (Long-Term Support) version of Node.js.

  • Verify installation: node -v and npm -v

• A Solana Wallet: Your identity is managed by a Solana wallet. Permagit is compatible with any wallet that can sign transactions (e.g., Phantom, Solflare, or a filesystem/ledger wallet). For the CLI, you will typically use a filesystem wallet (keypair file) for a server-side or CLI-pure environment.

2. Installing the Permagit CLI

Our primary tool is a command-line interface (CLI) that integrates directly with your terminal and Git. You can install it globally using npm.

Open your terminal and run the following command:

npm install -g permagit

This command downloads the permagit package and makes it available as a system-wide command.

3. Verifying the Installation

After the installation is complete, you can verify that it was successful by checking the version:

permagit --version

If the installation was successful, you will see the current version number printed to the console (e.g., permagit v0.1.0).

You can also run the help command to see a list of all available commands and options:

permagit --help

This will display an overview of the commands you will learn in this guide, such as init, push, clone, and login.

4. Initial Configuration (Setting up Irys)

Permagit uses Irys to bundle transactions and pay for Arweave storage. The CLI needs to know which Irys node to connect to and how to fund your uploads.

By default, Permagit is configured to use the main Irys node (node2.irys.xyz) and pay for storage using Solana (SOL).

To initialize Permagit and check your funding status, you can run:

permagit irys --status

This command will show you your current Irys balance. Before your first push, you will need to fund your Irys account. We will cover this in detail in Page 4: Basic Usage.