Nimman Documentation

Complete documentation for the Nimman CLI deployment tool.

Documentation Structure

📖 Full Documentation

Complete guide covering all features, commands, configuration options, examples, and troubleshooting.

Start here for: Comprehensive understanding of all features and advanced usage.

🚀 Getting Started

Quick start guide to get your application deployed in minutes.

Start here if: You want to deploy quickly and learn as you go.

⚡ Quick Reference

Quick reference card with common commands and configuration snippets.

Start here if: You're already familiar with Nimman and need a cheat sheet.

📝 Examples

Example configuration files for different use cases.

Start here if: You want to see real-world configuration examples.

Quick Navigation

For New Users

1. Read Getting Started
2. Check Examples for your use case
3. Refer to Full Documentation as needed

For Experienced Users

1. Use Quick Reference for commands
2. Check Examples for configuration patterns
3. See Full Documentation for advanced topics

Common Tasks

First Time Setup

nimman init
sudo nimman setup
nimman deploy

Update Deployment

git pull
nimman deploy

Deploy to Staging

nimman deploy --config nimman.staging.yml --env staging

Check Status

pm2 status
pm2 logs

Documentation Files

• document.md - Complete CLI documentation with detailed examples
• getting-started.md - Quick start guide
• quick-reference.md - Command and configuration reference
• examples/ - Example configuration files

Need Help?

• Check the Troubleshooting section in the full documentation
• Review Examples for configuration patterns
• Verify your setup matches the Getting Started guide

Contributing

Found an issue or have a suggestion? Please open an issue or pull request on the project repository.