🚀 InformatiQ CLI

A powerful command-line tool to streamline developer onboarding and machine setup for InformatiQ projects.

✨ Features

• 🩺 System Diagnostics: Verify your development environment setup (includes Docker check)
• 🔧 Auto-Installation: Automatically install missing dependencies (Node.js, Git, Docker)
• ⚙️ Interactive Configuration: Easy setup wizard for credentials and settings
• 🔐 Secure Storage: Credentials stored securely in OS keychain
• 📦 NPM Authentication: Automatic configuration for Azure DevOps package registry
• 🌍 Cross-Platform: Works on macOS, Linux, and Windows
• 🎨 Beautiful CLI: Colorful, emoji-rich interface for better UX

📦 Installation

Install globally using npm:

npm install -g informatiq

Or use npx to run without installation:

npx informatiq doctor

🚀 Quick Start

1. Configure Your Environment

Run the interactive setup wizard:

informatiq configure

You'll be prompted for:

• Email: Your email address
• PAT: Azure DevOps Personal Access Token

2. Verify Your Setup

Check if everything is configured correctly:

informatiq doctor

This command checks:

• ✅ Node.js installation
• ✅ NPM installation
• ✅ Git installation
• ✅ InformatiQ configuration
• ✅ NPM authentication
• ✅ Local projects

3. Start Developing! 🎉

You're all set! Your machine is now configured for InformatiQ development.

📖 Commands

informatiq doctor

Run system diagnostics to check your development environment.

# Check system without fixing
informatiq doctor

# Check and auto-fix issues
informatiq doctor --fix

What it checks:

• Node.js version (requires 16+)
• NPM installation
• Git installation
• Docker installation and daemon status
• InformatiQ configuration (PAT, email)
• NPM authentication setup

Auto-fix capabilities (--fix flag):

• 🔧 Installs Node.js via nvm if missing
• 🔧 Installs nvm if required
• 🔧 Installs Git using platform-specific package managers
• 🔧 Installs Docker (Homebrew on macOS, script on Linux, manual on Windows)
• 🔧 Starts Docker daemon if installed but not running

See Auto-Installation Guide for more details.

informatiq configure

Interactive setup wizard to configure your environment.

informatiq configure

# Force reconfiguration
informatiq configure --force

What it does:

1. Prompts for your email address
2. Prompts for Azure DevOps Personal Access Token
3. Saves credentials securely
4. Optionally configures NPM authentication

informatiq config

Manage configuration values.

# Display all configuration
informatiq config

# Get a specific value
informatiq config get pat
informatiq config get email

# Set a specific value
informatiq config set email [email protected]
informatiq config set pat <your-pat>

# List all configuration (same as 'informatiq config')
informatiq config list

# Clear all configuration
informatiq config clear
informatiq config clear --force  # Skip confirmation

Available configuration keys:

• pat: Personal Access Token
• email: Email address
• organization: Azure DevOps organization
• projectId: Azure DevOps project ID

🔐 Security

Credential Storage

InformatiQ CLI uses secure storage mechanisms:

• macOS: Keychain Access
• Windows: Credential Vault
• Linux: Secret Service API (libsecret)

If the OS keychain is unavailable, credentials are stored in an encrypted configuration file.

Personal Access Token (PAT)

To generate a PAT:

1. Visit Azure DevOps User Settings
2. Click "New Token"
3. Set scopes: Packaging (Read)
4. Copy the token and use it during configuration

⚠️ Important: Never share your PAT or commit it to version control!

📦 NPM Authentication

InformatiQ CLI automatically configures your .npmrc file for Azure DevOps package registry.

Manual Configuration

If you need to manually configure NPM authentication, add the following to ~/.npmrc:

//pkgs.dev.azure.com/informatiq/453f2307-e604-4108-b840-892f91a34e4d/_packaging/Packages/npm/registry/:username=informatiq
//pkgs.dev.azure.com/informatiq/453f2307-e604-4108-b840-892f91a34e4d/_packaging/Packages/npm/registry/:_password=<BASE64_ENCODED_PAT>
//pkgs.dev.azure.com/informatiq/453f2307-e604-4108-b840-892f91a34e4d/_packaging/Packages/npm/:username=informatiq
//pkgs.dev.azure.com/informatiq/453f2307-e604-4108-b840-892f91a34e4d/_packaging/Packages/npm/:_password=<BASE64_ENCODED_PAT>
//pkgs.dev.azure.com/informatiq/453f2307-e604-4108-b840-892f91a34e4d/_packaging/Packages/npm/:email=<YOUR_EMAIL>

Replace:

• <BASE64_ENCODED_PAT>: Base64-encoded version of your PAT
• <YOUR_EMAIL>: Your email address

🛠️ Development

Prerequisites

• Node.js 16 or higher
• npm or yarn

Setup

# Clone the repository
git clone https://github.com/likhononair/informatiq-cli.git
cd informatiq-cli

# Install dependencies
npm install

# Build the project
npm run build

# Run locally
npm run dev -- doctor

Scripts

• npm run build: Compile TypeScript to JavaScript
• npm run dev: Run CLI in development mode
• npm run watch: Watch for changes and rebuild
• npm test: Run tests
• npm run lint: Lint code
• npm run format: Format code with Prettier

Contributing

We use Conventional Commits for commit messages:

# Examples
git commit -m "feat: add new feature"
git commit -m "fix: resolve bug"
git commit -m "docs: update README"

Commit types:

• feat: New feature
• fix: Bug fix
• docs: Documentation changes
• style: Code style changes (formatting, etc.)
• refactor: Code refactoring
• perf: Performance improvements
• test: Test changes
• build: Build system changes
• ci: CI/CD changes
• chore: Other changes

🗺️ Roadmap

Future features planned:

• ☁️ Azure CLI Setup: Automatic Azure CLI installation and configuration
• 🔒 Proxy Management: Setup and run development proxy
• 📂 Project Cloning: Easy cloning of InformatiQ projects
• 🔑 SSL Certificates: Generate SSL certificates for local development
• ▶️ Project Runner: Quick start for InformatiQ projects
• 🔄 Auto-Updates: Automatic CLI updates
• 📊 Analytics: Development environment analytics
• 🎯 Templates: Project templates for quick starts

📄 License

ISC © InformatiQ Team

🤝 Support

• 📧 Email: [email protected]
• 💬 Slack: #dev-tools
• 🐛 Issues: GitHub Issues

🙏 Acknowledgments

Built with love using:

• Commander.js - CLI framework
• Inquirer.js - Interactive prompts
• Chalk - Terminal styling
• Ora - Elegant spinners
• Conf - Configuration management
• Keytar - Secure credential storage

Made with ❤️ by the InformatiQ Team