ajalt/mordant

Multiplatform text styling for Kotlin command-line applications https://ajalt.github.io/mordant/

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

	<repositories>
		<repository>
		    <id>jitpack.io</id>
		    <url>https://jitpack.io</url>
		</repository>
	</repositories>

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.ajalt:mordant:2.0.0-beta13'
	}

	dependencies {
		implementation("com.github.ajalt:mordant:2.0.0-beta13")
	}

	<dependency>
	    <groupId>com.github.ajalt</groupId>
	    <artifactId>mordant</artifactId>
	    <version>2.0.0-beta13</version>
	</dependency>


                            
    libraryDependencies += "com.github.ajalt" % "mordant" % "2.0.0-beta13"


                            
    :dependencies [[com.github.ajalt/mordant "2.0.0-beta13"]]

Readme

Mordant is a multiplatform library for rendering styled text in the terminal. You can use it to add color and style to text, create tables, draw animations, and more.

Mordant has:

Easy colorful ANSI output with automatic detection of terminal capabilities
Markdown rendering directly to the terminal
Widgets for laying out terminal output, including lists, tables, panels, and more
Support for animating any widget, like progress bars and dashboards

Documentation

The full documentation can be found on the website.

Installation

Mordant is distributed through Maven Central.

dependencies {
    implementation("com.github.ajalt.mordant:mordant:3.0.2")

    // optional extensions for running animations with coroutines
    implementation("com.github.ajalt.mordant:mordant-coroutines:3.0.2")

    // optional widget for rendering Markdown
    implementation("com.github.ajalt.mordant:mordant-markdown:3.0.2")
}

On JVM, there are more granular dependencies available. See the docs for details.

If you're using Maven instead of Gradle, use `<artifactId>mordant-jvm</artifactId>`

Snapshots

<details> <summary>Snapshot builds are also available</summary>

<p> You'll need to add the Sonatype snapshots repository:

repositories {
    maven {
        url = uri("https://oss.sonatype.org/content/repositories/snapshots/")
    }
}

</p> </details>

License

Copyright 2018 AJ Alt

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.