MND-DEV

Command line interface with install, update and quality of life functionality for all platform related mynewsdesk repos.

Install

The dev computer script installs it for you but if you need to do it manually simply run:

brew install --HEAD mynewsdesk/tap/mnd

Configuration

Run mnd setup to configure where you want to install the repos etc. All settings will be stored in YAML format in ~/.mnd.

After running setup you can install all the Mynewsdesk repos with mnd install. If you prefer to install only specific repositories you can run mnd list to get a list of all repos and then mnd install <repo-name> to install them one by one.

Please have a look at the Usage section below to get familiar with all available commands (mnd deploy is pretty great, for example).

Update

To update to the latest version simply run mnd update.

Usage

Check the usage by typing mnd help

Usage: mnd COMMAND [repo1 repo2] [command-specific-options]

Type 'mnd help COMMAND' for details of each command

Available commands:
deploy          Deploy app to a server
edit            Open repo source in editor
help            Helps you out!
install         Install missing repos
list            List all repos
logs            Tail logs
open            Conveniently opens services based on repository context
platform        Get or set the current platform
run             Run shell commands on multi-repos
setup           Configures the mnd tool
update          Self update
upgrade         Upgrade all or given repos

Check detail usage for one command mnd help logs:

Tail logs

Usage:
  mnd logs # tail all logs
  mnd logs mynewsdesk media_monitor # tail logs from mynewsdesk and media_monitor

  Note: tails log/development.log where available

Development setup

Clone the repo and run bin/setup

Run crystal build ./src/mnd.cr -o bin/mnd to build the executable.

Executable will be available as bin/mnd which you can run to test your changes before publishing.

If you are getting the library not found for -lssl error when attempting to compile please patch your LIBRARY_PATH as explained in: brianmario/mysql2#795 (comment)

Publish a new release

Just merge your changes to master. Running mnd update will reinstall using the current HEAD.

Add a repo

Add repos to the various platforms in src/mnd/platforms.cr.

Add command

Create a new command class in the src/mnd/commands directory:

module Mnd
  class Commands::Awesome < Commands::Base
    # The summary is one short sentence, which will appear in the help page
    # The usage is the details, which will appear when running 'mnd help awesome'
    summary "An awesome command"
    usage <<-EOF
    mnd awesome # show how awesome it is
    EOF

    # The command executes via the perform method
    def perform
      # Use display.[info|warn|error|debug] to display text on screen
      display.info "This is an awesome command!"
    end
  end
end

Useful methods in the Mnd::Commands::Base

Base#selected_repos

Get currently selected repos based on command line arguments.

For example when running, mnd logs mynewsdesk audience then the selected_repos will be ["mynewsdesk", "audience"].

However if no apps are specified it returns an empty array so when running mnd logs the selected_repos will be []. You might want to either display an error (return display.error "No repo specified if selected_repos.empty?") or default to use all apps (selected_repos.presence || Repo.all) in that case.

Base#display

Use display to get a display to print message instead of puts everywhere. It supports color in terminal. By default:

• display.info: default color
• display.error: red
• display.warn: yellow
• display.debug: light_black

Base#run(cmd, repo = nil)

Use it to run external command.

Parameters:

• cmd, String of the command you want to run
• repo, Optional if you want to run cmd on an repo

When repo is passed, it will cd to the root of repo then run the command.