mikrus CLI (Deno + Cliffy)

Command-line interface tool for managing VPS servers on the mikr.us platform. Built with the modern Deno runtime and Cliffy CLI framework. Inspired by mikrus-cli.

Installation

Quick Start (Binary Download)

# Download pre-compiled binary for your platform
curl -LO https://github.com/gander-tools/mikrus/releases/latest/download/mikrus-linux
chmod +x mikrus-linux
sudo mv mikrus-linux /usr/local/bin/mikrus

# Verify installation
mikrus --version
mikrus --help

Development Installation

# Clone repository
git clone https://github.com/gander-tools/mikrus.git
cd mikrus

# Run directly with Deno
deno task dev --help

# Or compile your own binary
deno task compile
./build/mikrus --help

Prerequisites

• Deno: >=2.5.0 (required) (Install Deno)
• Operating System: Linux, macOS, or Windows
• Permissions: --allow-read, --allow-write, --allow-net for full functionality

Verification

After installation, verify everything is working:

# Check version
mikrus --version

# View available commands
mikrus --help

# Test command help (example)
mikrus generate --help

Development

Building and Running

• deno task dev - Run CLI directly with Deno
• deno task compile - Compile single binary executable
• deno task compile:all - Compile for all platforms (Linux, Windows, macOS)

Code Quality

• deno task lint - Run Deno linter
• deno task fmt - Format code with Deno formatter
• deno task fmt:check - Check code formatting
• deno task check - Type check TypeScript files

Testing

• deno task test - Run all tests
• deno task test:coverage - Run tests with a coverage report
• deno task coverage:html - Generate HTML coverage report

Binary Compilation

# Single platform
deno task compile

# All platforms
deno task compile:all

# Custom target
deno compile --allow-read --allow-write --allow-net \
  --target=x86_64-pc-windows-msvc \
  --output=./mikrus-windows.exe \
  src/cli.ts

CI/CD Architecture

This project uses Deno-native CI/CD pipeline optimized for modern JavaScript runtime:

Core Workflow

• Deno CI - Complete Deno testing and deployment pipeline
  • Multi-platform testing (Ubuntu, Windows, macOS)
  • Security auditing and dependency scanning
  • Cross-platform binary compilation
  • Integration testing with compiled binaries

Workflow Features

• Native Deno Support: No Node.js or build steps required
• Permission-based Security: Explicit permission management
• Cross-platform Binaries: Linux, Windows, macOS compilation
• Zero Dependencies: URL-based imports, no node_modules
• Fast CI: Native TypeScript execution without a compilation step

Usage Examples

Basic Commands

# Display help and available commands
mikrus          # Shows usage automatically when no args provided
mikrus --help   # Explicit help command

# Generate a new component/model/service
mikrus generate <name>

# Check CLI version
mikrus --version

Advanced Usage

# Generate with alias
mikrus g <name>

# View command-specific help
mikrus generate --help

# Run with explicit permissions
deno run --allow-read --allow-write src/cli.ts generate example

Architecture Overview

Deno + Cliffy Stack

• Runtime: Deno 2.5+ (native TypeScript, secure by default)
• CLI Framework: Cliffy 1.0.0-rc.8 (modern, typed CLI commands)
• Dependencies: URL-based imports (no package.json dependencies)
• Testing: Deno native testing (no external frameworks)
• Security: Permission-based access control

Key Features

• Zero Configuration: No build step, no transpilation needed
• Type Safety: Native TypeScript support with strict type checking
• Security First: Explicit permissions for file system and network access
• Single Binary: Compile to standalone executable (~500MB)
• Cross Platform: Native support for Linux, macOS, Windows

Troubleshooting

Common Issues

Issue: mikrus: command not found

# Solution: Ensure binary is in PATH or use full path
export PATH="$PATH:/usr/local/bin"
# Or use full path
/usr/local/bin/mikrus --help

Issue: Permission errors

# Solution: Run with explicit permissions
deno run --allow-read --allow-write --allow-net src/cli.ts

Issue: Deno version compatibility

# Check your Deno version
deno --version
# Upgrade to Deno 2.5+ if needed
curl -fsSL https://deno.land/x/install/install.sh | sh

Getting Help

• 🔒 Security: Review security guidelines in docs/security.md
• 🐛 Issues: Report bugs at GitHub Issues
• 💬 Discussions: Join conversations in GitHub Discussions

📚 Project Documentation

Core Documentation

• 📋 Commands Reference - Complete CLI command documentation
• 🔒 Security Guidelines - Security best practices and compliance

Project Policies

• 📜 Security Policy - Vulnerability reporting and security procedures
• 🚀 Publishing Guide - Release and deployment procedures
• ⚖️ License - MIT License terms and conditions

Repository Health

• 🛡️ Security Status: Permission-based security model, daily automated scans
• 🧪 Test Coverage: Growing test suite with comprehensive security validation
• 🔄 CI/CD Pipeline: Deno-native testing and cross-platform compilation

---

Last Updated: 2025-08-26
License: MIT
Runtime: Deno 2.5+
Framework: Cliffy 1.0.0-rc.8