Skip to content
This repository has been archived by the owner on Jun 9, 2022. It is now read-only.

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
martinnirtl committed Feb 27, 2020
1 parent 95900ba commit 34275cc
Showing 1 changed file with 56 additions and 11 deletions.
67 changes: 56 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,58 @@
# Dockma CLI [WIP]

Level up your docker-compose game during development!
Official Website and Documentation on [dockma.dev](https://dockma.dev).

<!-- Level up your docker-compose game during development!
- No more navigating to your docker-compose file
- Create service host definitions dynamically whether they run in docker or locally
- Launch your defined services with an interactive CLI
- Switch between your docker(-compose) based projects
- Add custom commands by writing your own scripts
- Add custom commands by writing your own scripts -->

```
A fast and flexible CLI tool to boost your productivity during development in docker-compose based environments. Full documentation is available on https://dockma.dev.
Usage:
dockma [command]
Available Commands:
completion Generate shell completion code
config Dockma configuration details
down Downs active environment
env Environments reflect docker-compose based projects
help Help about any command
init Initialize the Dockma CLI.
inspect Print detailed output of previously executed external command
logs Logs output of all or only selected services
profile Manage profiles (named service selections)
ps List running services of active environment
restart Restart all or only selected services
script Run script (.sh) located in scripts dir of active environment
up Runs active environment with profile or service selection
version Print the version number of dockma.
Flags:
-h, --help help for dockma
-v, --verbose verbose output
Use "dockma [command] --help" for more information about a command.
```

## Content

- [Install](#install)
- [macOS](#macos)
- [Linux](#linux)
- [Windows](#windows)
- [Build from source](#build-from-source)
- [Setup](#setup)
- [Usage](#usage)
- [Commands](#commands)
- [Roadmap](#roadmap)
- [Features/Todos](#features/todos)
- [Other](#other)
- [Contribute](#contribute)

## Install

Expand All @@ -16,19 +62,17 @@ Level up your docker-compose game during development!

### Windows

### Build from source

## Setup

## Usage

## Commands
### Commands

## Scripts

## Contribute
## Roadmap

## TODOs

### Code-Related
### Features/Todos

- build command/solution to change selection without downing env in between
- add support for env var prefix (eg. 'DOCKMA\_') and make configurable per environment (subcommand 'env set' is taken and should prob be changed to 'env act(ivate)')
Expand All @@ -46,6 +90,7 @@ Level up your docker-compose game during development!

### Other

- finish makefile
- bind version, commit, date to vars provided on 'go build'
- use bats for system tests (https://github.com/sstephenson/bats)
- show build tags etc. on top of readme

## Contribute

0 comments on commit 34275cc

Please sign in to comment.