@throskam/eko

0.4.3 • Public • Published

Multi-projects management tool

CircleCI Codecov npm-version npm-license

A CLI tool to manage multiple projects as a single meta project.

Features

  • generic: run any commands
  • performant: run commands in parallel
  • shareable: local configuration file

Installation

npm install -g @throskam/eko

Usage

See eko --help for details.

Managing the project

If you already have a directory containing multiple projects you can use the command discover to search recursively for git repositories.

eko discover

Otherwise, you can manually add repositories with add.

eko add <repository> [directory]

You can optionally create a repository for your eko project itself. That way, anyone would be able to clone it using the clone command.

eko clone <ekoable-repository> [directory]

You can use the sync command to synchronize your project with its .eko file.

eko sync

Note that this command is only additive and won't remove any file.

You can organise your projects with tags using the tag command.

eko tag my-tag -i

Executing Commands

eko exec -- echo "Hi from \$PWD"

Note that without the double dashes (--), conflicting flags will be interpreted as eko flags.

You can create aliases to save commands under shorter names.

eko alias greeting -- echo "echo "Hi from \$PWD""

And then use them in exec.

eko exec greeting

Colors

Colors in commands output are unfortunately not preserved because most command line tools, like git, only activate colors if the output stream is the TTY itself and not a pipe. For instance git status | cat will print no colors.

In many cases, you can circumvent this issue by adding flags to the command.

git -c color.status=always status | cat

This method can be apply with eko too

eko exec -- git -c color.status=always status

Roadmap

  • Support for recursive project (execute clone, sync, exec and status recursively)
  • Support for calling eko from a child directory like git does
  • Support for tags as a grouping mechanism

Contributing

See CONTRIBUTING.md

Related projects

Package Sidebar

Install

npm i @throskam/eko

Weekly Downloads

9

Version

0.4.3

License

MIT

Unpacked Size

67.1 kB

Total Files

53

Last publish

Collaborators

  • throskam