easy-containers 1.0.0

package/ .npmignore

@@ -0,0 +1,13 @@
+# .npmignore
+node_modules/
+.git/
+.gitignore
+*.log
+.DS_Store
+test/
+tests/
+*.test.js
+*.spec.js
+.github/
+docs/
+examples/

package/Examples.md

@@ -0,0 +1,101 @@
+# Easy Containers CLI Examples
+
+## 1. Start and stop a service
+
+```bash
+easy up postgres
+easy status
+easy down postgres
+```
+
+## 2. Download first, then run
+
+```bash
+easy download redis
+easy up redis
+```
+
+## 3. List installed and available services
+
+```bash
+easy list
+easy list --all
+```
+
+## 4. Search services
+
+```bash
+easy search kafka
+easy search sql
+```
+
+## 5. View logs
+
+```bash
+# Last lines
+easy logs postgres
+
+# Follow live
+easy logs postgres --follow
+
+# Last 20 lines
+easy logs postgres --tail 20
+```
+
+## 6. Check and inspect configuration
+
+```bash
+easy show postgres
+easy validate postgres
+```
+
+## 7. Manage environment values
+
+```bash
+# Interactive config
+easy config postgres
+
+# Edit .env in editor
+easy config postgres --edit
+
+# Show current values
+easy config postgres --show
+
+# Reset from sample
+easy config postgres --reset
+```
+
+## 8. Run command inside container
+
+```bash
+# Open shell
+easy exec postgres
+
+# Run direct command
+easy exec postgres psql -U postgres
+```
+
+## 9. Update and restart
+
+```bash
+easy pull postgres
+easy restart postgres
+```
+
+## 10. Create a new local service template
+
+```bash
+easy init myapp
+easy init mydb --template database
+easy up myapp
+```
+
+## 11. Useful flow for daily use
+
+```bash
+easy list
+easy up redis
+easy logs redis --follow
+# Ctrl+C to stop log stream
+easy down redis
+```

package/Project structure.md

@@ -0,0 +1,82 @@
+# Easy Containers CLI Project Structure
+
+This file explains what each main folder does.
+
+## CLI folder layout
+
+```text
+cli/
+├── bin/
+│   └── cli.js
+├── src/
+│   ├── commands/
+│   ├── constants/
+│   └── utils/
+├── README.md
+├── Examples.md
+├── Project structure.md
+└── package.json
+```
+
+## Folder details
+
+### `bin/`
+
+- `cli.js`: Program entry point.
+- Defines all command routes using Commander.
+
+### `src/commands/`
+
+Each file maps to one CLI command.
+
+- `up.js`: start service
+- `down.js`: stop service
+- `list.js`: list installed services (and available with `--all`)
+- `download.js`: download service files
+- `show.js`: show service details
+- `status.js`: show running containers
+- `logs.js`: show service logs
+- `restart.js`: restart service
+- `pull.js`: pull updated images
+- `exec.js`: run command in container
+- `config.js`: manage `.env`
+- `validate.js`: validate compose config
+- `search.js`: search available services
+- `init.js`: create new local template
+- `help.js`: custom help output
+- `index.js`: exports all command handlers
+
+### `src/utils/`
+
+Shared helper logic used by commands.
+
+- `docker.js`: runs docker and docker-compose commands, docker checks
+- `config.js`: service paths and available-services lookup
+- `downloader.js`: downloads service folder from repository
+
+### `src/constants/`
+
+- `repository.js`: repository URL, branch, and services path constants
+
+## Runtime location
+
+When the CLI runs, service files are stored in:
+
+```text
+~/.easy-containers/services/
+```
+
+## Typical command flow
+
+For `easy up postgres`:
+
+1. `bin/cli.js` receives command
+2. `src/commands/up.js` runs
+3. `src/utils/downloader.js` ensures service exists locally
+4. `src/utils/docker.js` runs `docker-compose up -d`
+
+For `easy list --all`:
+
+1. `src/commands/list.js` runs
+2. Installed services are read from local path
+3. Available services are fetched via `src/utils/config.js`

package/README.md

@@ -0,0 +1,96 @@
+# Easy Containers CLI
+
+Easy Containers is a command line tool to manage Docker services quickly.
+
+## Requirements
+
+- Docker running on your machine
+- Docker Compose available in your PATH
+- Node.js 14+
+
+## Install
+
+```bash
+git clone https://github.com/arjavdongaonkar/easy-containers.git
+cd easy-containers/cli
+npm install
+npm link
+```
+
+## Basic usage
+
+```bash
+easy <command> [service] [options]
+```
+
+Run help anytime:
+
+```bash
+easy help
+```
+
+## Commands
+
+### Service commands
+
+- `easy download <service>`: Download service files from repository
+- `easy up <service>`: Start a service
+- `easy down <service>`: Stop a service
+- `easy restart <service>`: Restart a service
+- `easy pull <service>`: Pull latest image updates
+- `easy logs <service>`: Show logs for a service
+- `easy show <service>`: Show service details from compose file
+- `easy exec <service> [command...]`: Run a command inside running container
+- `easy config <service>`: Manage `.env` values
+- `easy validate <service>`: Validate compose configuration
+
+### Global commands
+
+- `easy list`: Show installed services
+- `easy list --all`: Show all available services from repository
+- `easy search <query>`: Search available services
+- `easy status` (alias: `easy ps`): Show running containers
+- `easy init <service>`: Create a new local service template
+- `easy help`: Show help
+
+## Quick examples
+
+```bash
+# Start PostgreSQL
+easy up postgres
+
+# See what's installed
+easy list
+
+# See all available services
+easy list --all
+
+# Follow logs
+easy logs postgres --follow
+
+# Validate compose file
+easy validate postgres
+
+# Open shell in container
+easy exec postgres
+```
+
+## Where services are stored
+
+Installed services are stored in:
+
+```text
+~/.easy-containers/services/
+```
+
+Each service directory usually contains:
+
+- `docker-compose.yml`
+- `env.sample` (if provided)
+- `.env` (created/managed locally)
+
+## Notes
+
+- If a service is not installed, `easy up <service>` will try to download it first.
+- Use `easy config <service>` to create/edit `.env` values safely.
+- Use `easy down <service> --volumes` if you want to remove volumes too.

package/bin/cli.js

@@ -0,0 +1,281 @@
+#!/usr/bin/env node
+
+const { program } = require('commander');
+const chalk = require('chalk');
+const {
+  up,
+  down,
+  download,
+  list,
+  show,
+  status,
+  logs,
+  restart,
+  init,
+  pull,
+  exec,
+  search,
+  validate,
+  config,
+  help
+} = require('../src/commands');
+const { verifyDockerEnvironment } = require('../src/utils/docker.js');
+
+
+// Package info
+const packageJson = require('../package.json');
+
+// ASCII Art Banner
+const banner = `
+${chalk.cyan('╔═══════════════════════════════════════╗')}
+${chalk.cyan('║')}     ${chalk.bold.white('🐳 Easy Containers CLI')}            ${chalk.cyan('║')}
+${chalk.cyan('║')}     ${chalk.gray('Simplify Docker Management')}        ${chalk.cyan('║')}
+${chalk.cyan('╚═══════════════════════════════════════╝')}
+`;
+
+// Show banner
+console.log(banner);
+
+// Configure CLI
+program
+  .name('easy')
+  .description('CLI tool for managing Docker containers easily')
+  .version(packageJson.version, '-v, --version', 'Output the current version')
+  .helpOption('-h, --help', 'Display help for command')
+  .addHelpCommand(false);
+
+// Up command - Start containers
+program
+  .command('up <service>')
+  .description('Start a container service')
+  .option('-d, --detach', 'Run containers in detached mode (default)', true)
+  .option('-f, --file <file>', 'Specify an alternate compose file')
+  .action(async (service, options) => {
+    try {
+      await verifyDockerEnvironment();
+      await up(service, options);
+    } catch (error) {
+      console.error(chalk.red(`\n❌ Error: ${error.message}\n`));
+      process.exit(1);
+    }
+  });
+
+// Down command - Stop containers
+program
+  .command('down <service>')
+  .description('Stop and remove containers')
+  .option('-v, --volumes', 'Remove named volumes')
+  .action(async (service, options) => {
+    try {
+      await verifyDockerEnvironment();
+      await down(service, options);
+    } catch (error) {
+      console.error(chalk.red(`\n❌ Error: ${error.message}\n`));
+      process.exit(1);
+    }
+  });
+
+// List command - List services
+program
+  .command('list')
+  .alias('ls')
+  .description('List installed container services')
+  .option('-a, --all', 'Show all available services from repository')
+  .option('-v, --verbose', 'Show detailed information including descriptions')
+  .action(async (options) => {
+    try {
+      await list(options);
+    } catch (error) {
+      console.error(chalk.red(`\n❌ Error: ${error.message}\n`));
+      process.exit(1);
+    }
+  });
+
+// Download command - Download service files
+program
+  .command('download <service>')
+  .description('Download service configuration from repository')
+  .action(async (service) => {
+    try {
+      await download(service);
+    } catch (error) {
+      console.error(chalk.red(`\n❌ Error: ${error.message}\n`));
+      process.exit(1);
+    }
+  });
+
+// Show command - Show service details
+program
+  .command('show <service>')
+  .description('Display detailed information about a service')
+  .action(async (service) => {
+    try {
+      await show(service);
+    } catch (error) {
+      console.error(chalk.red(`\n❌ Error: ${error.message}\n`));
+      process.exit(1);
+    }
+  });
+
+// Status command - Container status
+program
+  .command('status')
+  .alias('ps')
+  .description('Show status of running containers')
+  .option('-v, --verbose', 'Show additional information')
+  .action(async (options) => {
+    try {
+      await verifyDockerEnvironment();
+      await status(options);
+    } catch (error) {
+      console.error(chalk.red(`\n❌ Error: ${error.message}\n`));
+      process.exit(1);
+    }
+  });
+
+// Logs command - View logs
+program
+  .command('logs <service>')
+  .description('View container logs')
+  .option('-f, --follow', 'Follow log output')
+  .option('-n, --tail <lines>', 'Number of lines to show from the end', '100')
+  .option('-t, --timestamps', 'Show timestamps')
+  .action(async (service, options) => {
+    try {
+      await verifyDockerEnvironment();
+      await logs(service, options);
+    } catch (error) {
+      console.error(chalk.red(`\n❌ Error: ${error.message}\n`));
+      process.exit(1);
+    }
+  });
+
+// Restart command - Restart containers
+program
+  .command('restart <service>')
+  .description('Restart a container service')
+  .action(async (service, options) => {
+    try {
+      await verifyDockerEnvironment();
+      await restart(service, options);
+    } catch (error) {
+      console.error(chalk.red(`\n❌ Error: ${error.message}\n`));
+      process.exit(1);
+    }
+  });
+
+// Init command - Initialize new service
+program
+  .command('init <service>')
+  .description('Initialize a new container service')
+  .option('-t, --template <template>', 'Use a template (basic, database, webapp)')
+  .action(async (service, options) => {
+    try {
+      await init(service, options);
+    } catch (error) {
+      console.error(chalk.red(`\n❌ Error: ${error.message}\n`));
+      process.exit(1);
+    }
+  });
+
+// Pull command - Pull images
+program
+  .command('pull <service>')
+  .description('Pull/update container images for a service')
+  .action(async (service, options) => {
+    try {
+      await verifyDockerEnvironment();
+      await pull(service, options);
+    } catch (error) {
+      console.error(chalk.red(`\n❌ Error: ${error.message}\n`));
+      process.exit(1);
+    }
+  });
+
+// Exec command - Execute command in container
+program
+  .command('exec <service> [command...]')
+  .description('Execute a command in a running container')
+  .option('-i, --interactive', 'Keep STDIN open (interactive mode)', true)
+  .action(async (service, command, options) => {
+    try {
+      await verifyDockerEnvironment();
+      await exec(service, command, options);
+    } catch (error) {
+      console.error(chalk.red(`\n❌ Error: ${error.message}\n`));
+      process.exit(1);
+    }
+  });
+
+// Search command - Search services
+program
+  .command('search <query>')
+  .description('Search for available container services')
+  .action(async (query) => {
+    try {
+      await search(query);
+    } catch (error) {
+      console.error(chalk.red(`\n❌ Error: ${error.message}\n`));
+      process.exit(1);
+    }
+  });
+
+// Validate command - Validate configuration
+program
+  .command('validate <service>')
+  .description('Validate docker-compose configuration')
+  .action(async (service) => {
+    try {
+      await validate(service);
+    } catch (error) {
+      console.error(chalk.red(`\n❌ Error: ${error.message}\n`));
+      process.exit(1);
+    }
+  });
+
+// Config command - Manage service configuration
+program
+  .command('config <service>')
+  .description('Manage service configuration and environment variables')
+  .option('-e, --edit', 'Edit .env file in default editor')
+  .option('-s, --show', 'Show current configuration')
+  .option('-r, --reset', 'Reset to default configuration from sample')
+  .action(async (service, options) => {
+    try {
+      await config(service, options);
+    } catch (error) {
+      console.error(chalk.red(`\n❌ Error: ${error.message}\n`));
+      process.exit(1);
+    }
+  });
+
+// Help command - Enhanced guide
+program
+  .command('help')
+  .description('Show detailed help and examples')
+  .action(async () => {
+    try {
+      await help();
+    } catch (error) {
+      console.error(chalk.red(`\n❌ Error: ${error.message}\n`));
+      process.exit(1);
+    }
+  });
+
+// Parse arguments
+program.parse(process.argv);
+
+// Show help if no command provided
+if (!process.argv.slice(2).length) {
+  program.outputHelp();
+  
+  console.log(chalk.cyan('\nQuick Start:\n'));
+  console.log(chalk.gray('  easy up postgres       # Start PostgreSQL'));
+  console.log(chalk.gray('  easy config postgres   # Configure environment'));
+  console.log(chalk.gray('  easy status            # Check running containers'));
+  console.log(chalk.gray('  easy logs postgres     # View logs'));
+  console.log(chalk.gray('  easy down postgres     # Stop PostgreSQL'));
+  console.log(chalk.gray('\n  easy init myapp        # Create new service'));
+  console.log(chalk.gray('  easy search mysql      # Search services'));
+  console.log(chalk.gray('  easy list              # List installed services\n'));
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "easy-containers",
+  "version": "1.0.0",
+  "description": "CLI tool for managing Docker containers easily",
+  "main": "bin/cli.js",
+  "bin": {
+    "easy": "bin/cli.js"
+  },
+  "scripts": {
+    "start": "node bin/cli.js",
+    "test": "jest",
+    "lint": "eslint ."
+  },
+  "keywords": [
+    "docker",
+    "docker-compose",
+    "containers",
+    "cli",
+    "devops"
+  ],
+  "author": "Yash Rajput",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/arjavdongaonkar/easy-containers.git"
+  },
+  "bugs": {
+    "url": "https://github.com/arjavdongaonkar/easy-containers/issues"
+  },
+  "homepage": "https://github.com/arjavdongaonkar/easy-containers#readme",
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "cli-table3": "^0.6.3",
+    "commander": "^11.1.0",
+    "inquirer": "^8.2.5",
+    "js-yaml": "^4.1.0",
+    "ora": "^5.4.1"
+  },
+  "devDependencies": {
+    "eslint": "^8.54.0",
+    "jest": "^29.7.0"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}