Solar CLI

A powerful command-line interface tool for Solana developers that simplifies common development tasks.

Features

• 🛠️ Automated development environment setup
• 🔍 Development environment verification
• 🔄 Easy CLI updates with automatic package manager detection
• 🔑 Generate and manage Solana keypairs
• 👛 View wallet information
• 💫 Request SOL airdrops for development
• ⚙️ Flexible configuration management (global & local)
• 🔄 Sync settings with Solana CLI
• 💻 Interactive mode for easier usage
• 🌐 Support for multiple networks (localnet, devnet, testnet, mainnet)

Development

Prerequisites

• Bun v1.1.42 or higher
• Node.js 18 or higher

Setup

1. Clone the repository:

git clone https://github.com/nitishxyz/solar.git
cd solar

2. Install dependencies:

bun install

3. Run in development mode:

bun run cli.ts

Building

Build the project:

bun run build

The built files will be in the dist directory.

Installation

From NPM

npm install -g @nitishxyz/solar

From Source

npm install -g .

Usage

Interactive Mode

Start the interactive CLI interface:

solar
# or
solar -i

Command Mode

solar <command> [options]

Available Commands

Setup & Maintenance

solar setup
  Set up development environment (installs Rust, Solana CLI, and Anchor)

solar doctor
  Verify development environment dependencies

solar upgrade
  Update Solar CLI to the latest version

Configuration

solar config [options] [network]
  -g, --global    Use global configuration
  -l, --local     Use local configuration (default)
  -s, --show      Show current configuration
  -i, --init      Initialize configuration file
  -k, --keypair   <path> Set keypair path

Wallet & Keypair Management

solar wallet
  View current wallet information

solar keygen [options]
  -g, --global    Save to global keypair location

solar keyinfo <file>
  View keypair information

Airdrop

solar airdrop [address]
  Request 1 SOL airdrop for development
  If no address is provided, uses the current configured wallet

Sync with Solana CLI

solar sync
  Sync configuration with Solana CLI

Configuration

Solar CLI supports both global and local configuration:

• Global config: ~/.config/solar/config.json
• Local config: ./solar-config.json (in project directory)

Local configuration takes precedence over global configuration.

Supported Networks

• localnet: http://127.0.0.1:8899
• devnet: https://api.devnet.solana.com
• testnet: https://api.testnet.solana.com
• mainnet: https://api.mainnet-beta.solana.com
• Custom RPC URL

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Built with Bun
• Uses Solana Web3.js