# @aship/cli

CLI implementation package for aship - a zero-config Ansible tool for simplified deployments and flexible host management.

> **📋 For complete usage documentation, see the main [aship](https://www.npmjs.com/package/aship) package.**

This package contains the technical CLI implementation. Most users should install and refer to the main `aship` package for usage instructions.

## 📦 Installation

### Prerequisites

- **Node.js** 18.0.0 or higher

### Install

```bash
# Recommended: Install the main package
npm install -g aship

# Or using pnpm
pnpm add -g aship

# For developers: Install CLI implementation directly
npm install -g @aship/cli

# Or using pnpm
pnpm add -g @aship/cli
```

## 🔧 Technical Details

This package provides the underlying CLI implementation using:
- **OCLIF Framework**: Modern CLI framework with TypeScript support
- **Interactive Prompts**: Rich user interaction with inquirer.js
- **Command Structure**: Modular command architecture with aliases
- **Host Management**: Persistent host configuration and usage tracking

## 📖 Complete Documentation

For comprehensive usage documentation, configuration examples, and tutorials:

**👉 [Complete Usage Guide](https://www.npmjs.com/package/aship)** - See the main aship package for:
- Installation and setup instructions
- Complete command reference with examples
- Configuration guides and patterns
- Usage workflows and best practices

**📚 [Project Repository on GitHub](https://github.com/teomyth/aship)**
- Example projects and tutorials
- Troubleshooting guides
- Development and contribution guides

## 🔗 Related Packages

- **[aship](https://www.npmjs.com/package/aship)** - Main user-facing package
- **[@aship/core](https://www.npmjs.com/package/@aship/core)** - Core functionality library

## 🤝 Contributing

This package is part of the aship project. Please refer to the [main project documentation](https://github.com/teomyth/aship) for contribution guidelines.

## 📄 License

MIT - see the [main project LICENSE file](https://github.com/teomyth/aship/blob/main/LICENSE) for details.