rocktopus v0.1.0

rocktopus CLI is a tool for Developers to switch between multiple Projects.

Why should I use rocktopus?

Situation

As a developer, you may know the following story.

It's 10 AM. Bob got the task to develop a feature in project 712. To do this, he opens his console, switches to his workspace, checks whether project 712 is there, finds out that project 712 is probably not in the workspace. Maybe he cloned it somewhere else? Anyways. He clones the project via git, but not without searching in the pesky web interface how this was done again. :clock1030:

After checking out only a short npm install, composer install, docker-compose up -d is missing to get started. :clock12:

And its lunch break. Finally! :hamburger:

Solution

rocktopus takes care of it!

This small command line tool is developed for ...

• Checking your workspace if a project already exists :white_check_mark:
• Cloning projects using GIT :white_check_mark:
• Running context fed and freely configurable jobs after the project is there :white_check_mark:

Plus: Who doesn't like octopuses? :octopus:

Use rocktopus

NPX

Because this package is shipped to npm you can simply execue it via npx:

npx rocktopus

NPM Install

Install the rocktpus CLI for later usage via npm:

npm i -g rocktopus

Commands

Workspaces

To help you switch quickly and easily between several projects, rocktopus stores so-called workspaces.

Workspaces correspond to a grouped collection of projects. E.g. if you have several microservices in the same source control system and under the same organization.

$ rocktopus workspace --help

Usage: rocktopus workspace|ws [options] [command]

Manage workspaces managed by rocktopus

Options:
  -h, --help             display help for command

Commands:
  list [options]         List workspaces managed by rocktopus
  add [options]          Add a workspace managed by rocktopus
  delete [options]       Delete a workspaces managed by rocktopus identified by its slug
  edit [options]         Edit a workspace managed by rocktopus
  set-default [options]  Sets the default workspace for rocktopus
  help [command]         display help for command

Execution

Afer configuring your workspaces you might want to get started.

$ rocktopus exec --help

Usage: rocktopus exec [options] <project-name>

Execute jobs for the giving project inside the workspace

Arguments:
  project-name                 Name of the project inside the workspace

Options:
  -w, --workspace <workspace>  Slug of the workspace
  -v, --verbose                Verbose mode
  --no-color                   Output without colors
  -h, --help                   display help for command