https://github.com/aca-labs/terminimal

A tiny CLI toolkit for building terminal apps for humans.
https://github.com/aca-labs/terminimal

cli crystal-lang library

Last synced: 7 days ago
JSON representation

A tiny CLI toolkit for building terminal apps for humans.

• Host: GitHub
• URL: https://github.com/aca-labs/terminimal
• Owner: aca-labs
• License: mit
• Created: 2019-07-16T06:12:45.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-24T03:14:27.000Z (16 days ago)
• Last Synced: 2024-11-02T04:04:43.058Z (7 days ago)
• Topics: cli, crystal-lang, library
• Language: Crystal
• Homepage: https://aca-labs.github.io/terminimal/
• Size: 42 KB
• Stars: 16
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-crystal - terminimal - A tiny CLI toolkit for building terminal apps for humans (CLI Utils)

README

        
# Terminimal

[![GitHub release](https://img.shields.io/github/release/aca-labs/terminimal.svg)](https://github.com/aca-labs/terminimal/releases)

[![Build Status](https://travis-ci.com/aca-labs/terminimal.svg?branch=master)](https://travis-ci.com/aca-labs/terminimal)

[![Docs](https://img.shields.io/badge/docs-available-brightgreen.svg)](https://aca-labs.github.io/terminimal/)

![](https://static.thenounproject.com/png/2130677-200.png)

Terminimal is a tiny toolkit for building CLI apps in crystal-lang that are designed for humans.

It provides a nice API and wrappers for ANSI escape sequences and a selection of useful tools for building simple, aesthetically pleasing output.

![](demo.svg)

## Installation

1. Add the dependency to your `shard.yml`:

   ```yaml

   dependencies:

     terminimal:

       github: aca-labs/terminimal

   ```

2. Run `shards install`

## Usage

```crystal

require "terminimal"

```

[Read the docs](https://aca-labs.github.io/terminimal/)

## Contributing

1. Fork it ()

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request

## Contributors

- [Kim Burgess](https://github.com/kimburgess) - creator and maintainer