# cidrly

Network architecture and design planning CLI tool with automatic subnet calculations, VLAN management, and an interactive terminal dashboard.

[![npm version](https://img.shields.io/npm/v/cidrly)](https://www.npmjs.com/package/cidrly)
[![npm downloads](https://img.shields.io/npm/dm/cidrly)](https://www.npmjs.com/package/cidrly)
[![Node Version](https://img.shields.io/node/v/cidrly)](https://nodejs.org)
[![License: CC BY-NC-SA 4.0](https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg)](LICENSE)

## Features

- **Terminal dashboard** with keyboard navigation and row virtualization
- **VLSM optimization** with "Largest First" allocation
- **Dual efficiency metrics** (Supernet + Range)
- **Configurable capacity planning** - Adjust growth percentage from 0-200% (default: 100%)
- **Sortable table columns** - Sort by any column with Tab + arrow keys
- **Automatic subnet and supernet calculation**
- **VLAN management** with per-subnet tracking (1-4094)
- **Manual network locking** - Lock specific subnets to fixed addresses
- **Auto-fit blocks** - Allocate subnets to specific IP blocks
- **Save/load network plans** as JSON with per-plan preferences

### Import

- **CSV** - Import from spreadsheets
- **YAML** - Import from IaC configurations
- **Vendor configs** - Cisco IOS/NX-OS, Juniper JunOS, Arista EOS, FortiGate, Netgear, Ubiquiti

### Export

- **YAML** - Infrastructure as Code workflows
- **CSV** - Spreadsheet compatibility with metadata headers
- **PDF** - Documentation and reports
- **Terraform** - AWS, Azure, GCP configurations
- **Vendor configs** - Cisco IOS/NX-OS, Juniper JunOS, Arista EOS, FortiGate, Netgear, Ubiquiti

## Requirements

- **Node.js**: 24.0.0 or higher
- **npm**: 10.0.0 or higher

## Installation

**Homebrew (macOS/Linux):**

```bash
brew tap chuckycastle/cidrly
brew install cidrly
cidrly
```

**NPM (All Platforms):**

```bash
npm install -g cidrly
cidrly
```

## Usage

Launch the interactive dashboard:

```bash
cidrly
```

Or use CLI commands:

```bash
cidrly create --name="My Network" --save
cidrly add --name="Engineering" --vlan=10 --devices=50 --plan=my-network.json
cidrly calculate --plan=my-network.json
cidrly view --plan=my-network.json
```

## Examples

See [examples/](examples/) for sample network plans:

- `example-campus-network.json` - Multi-building university network
- `example-data-center.json` - Three-tier application infrastructure
- `example-branch-office.json` - Small office network

## Documentation

Documentation is available on the [GitHub Wiki](https://github.com/chuckycastle/cidrly/wiki):

- **[User Guide](https://github.com/chuckycastle/cidrly/wiki/User-Guide)** - Getting started, basic concepts, common workflows, and troubleshooting
- **[Keyboard Shortcuts](https://github.com/chuckycastle/cidrly/wiki/Keyboard-Shortcuts)** - Complete reference for all keyboard shortcuts
- **[Examples and Tutorials](https://github.com/chuckycastle/cidrly/wiki/Examples)** - Practical examples and step-by-step tutorials

## Contributing

Contributions are welcome. Here's how to help:

### Reporting Bugs

Found a bug? Please use our [Bug Report template](https://github.com/chuckycastle/cidrly/issues/new?template=bug_report.yml) to provide:

- Clear description of the issue
- Steps to reproduce
- Your environment (cidrly version, Node.js version, OS)
- Error logs if available

### Feature Requests

Have an idea? Submit a [Feature Request](https://github.com/chuckycastle/cidrly/issues/new?template=feature_request.yml) with:

- Description of the feature
- Use case and problem it solves
- Proposed implementation ideas

### Questions & Documentation

- **Questions**: Use our [Question template](https://github.com/chuckycastle/cidrly/issues/new?template=question.yml)
- **Documentation**: Help improve docs with our [Documentation template](https://github.com/chuckycastle/cidrly/issues/new?template=documentation.yml)

### Code Contributions

See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.

## Support

For issues or feature requests, open an issue on [GitHub](https://github.com/chuckycastle/cidrly/issues).