magikube

⚡️ Run production grade applications in minutes ⚡️

• Get Ready
• Quick Install
• What you will need to start
• Commands
• Documentation

Get Ready

1. Node.js version 18.0 or above
2. homebrew from https://brew.sh
3. Python 3.12

   brew install [email protected]

4. tfenv

   brew install tfenv

5. Terraform 1.8.2

   tfenv install 1.8.2

6. Ansible

   brew install ansible@10

You are all set for magikube now.

Quick Install

With npm:

npm i -g magikube

What you will need to start

Magikube will need a few things to be able to setup environment for you.

1. If you have already configured AWS credentials then you will need profile name and skip to step 3
2. AWS Access Key / Secret
3. Github personal access token for user that has admin rights
4. Github Organisation name

Commands

• magikube destroy NAME
• magikube new NAME
• magikube new_module PROJECTNAME MODULETYPE MODULENAME
• magikube new_template NAME
• magikube restart NAME

magikube destroy NAME

Destroy magikube project

USAGE
  $ magikube destroy NAME [-d]

ARGUMENTS
  NAME  Project name to be destroyed

FLAGS
  -d, --dryrun  Simulates execution of the command, showing what would happen without making any real changes to the
                system.

DESCRIPTION
  Destroy magikube project

EXAMPLES
  $ magikube destroy sample
  Destroying magikube project named 'sample' in the current directory

magikube new NAME

Create new magikube project

USAGE
  $ magikube new NAME

ARGUMENTS
  NAME  Project name to be created

DESCRIPTION
  Create new magikube project

EXAMPLES
  $ magikube new sample
      Creating a new magikube project named 'sample' in the current directory

magikube new_module PROJECTNAME MODULETYPE MODULENAME

Create a new module in an existing Magikube project

USAGE
  $ magikube new_module PROJECTNAME MODULETYPE MODULENAME

ARGUMENTS
  PROJECTNAME  Base project name
  MODULETYPE   Type of module (e.g., eks-fargate, k8s)
  MODULENAME   Name of the module to be created

DESCRIPTION
  Create a new module in an existing Magikube project

EXAMPLES
  $ magikube new_module myProject eks-fargate myNewModule
      Creates a new module named 'myNewModule' of type 'eks-fargate' in the project 'myProject'

magikube new_template NAME

Create new magikube project with custom templates

USAGE
  $ magikube new_template NAME [-t <value>]

ARGUMENTS
  NAME  Project name to be created

FLAGS
  -t, --template=<value>  Template name to use for project creation (optional)

DESCRIPTION
  Create new magikube project with custom templates

EXAMPLES
  $ magikube new_template sample
      Creating a new magikube project named 'sample' in the current directory

  $ magikube new_template sample -t templateName
      Creating a new magikube project named 'sample' using 'templateName' template in the current directory

magikube restart NAME

Restart the magikube project from where it left off

USAGE
  $ magikube restart NAME

ARGUMENTS
  NAME  Project name to be restarted

DESCRIPTION
  Restart the magikube project from where it left off

EXAMPLES
  $ magikube restart sample 
       Restarting magikube project named 'sample' from where it left off

Documentation

Detailed documentation can be found here which includes:

1. Introduction
2. How to Guides