https://github.com/slackhq/kotlin-cli-util

Kotlin CLI utilities, mostly intended for use with Clikt
https://github.com/slackhq/kotlin-cli-util

cli clikt kotlin kotlin-script

Last synced: about 1 year ago
JSON representation

Kotlin CLI utilities, mostly intended for use with Clikt

• Host: GitHub
• URL: https://github.com/slackhq/kotlin-cli-util
• Owner: slackhq
• License: apache-2.0
• Archived: true
• Created: 2022-03-02T19:27:54.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-14T20:05:58.000Z (over 1 year ago)
• Last Synced: 2025-04-22T12:15:22.047Z (about 1 year ago)
• Topics: cli, clikt, kotlin, kotlin-script
• Language: Kotlin
• Homepage:
• Size: 530 KB
• Stars: 37
• Watchers: 6
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE.txt
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# ⚠️ ARCHIVED

This project has moved to a new home! https://github.com/slackhq/foundry/tree/main/tools/cli

---

# Kotlin CLI Utils

A repo containing basic CLI utilities for Kotlin.

## Installation

[![Maven Central](https://img.shields.io/maven-central/v/com.slack.cli/kotlin-cli-util.svg)](https://mvnrepository.com/artifact/com.slack.cli/kotlin-cli-util)

```gradle

dependencies {

  implementation("com.slack.cli:kotlin-cli-util:")

}

```

Snapshots of the development version are available in [Sonatype's `snapshots` repository][snap].

## Local testing

If consuming these utilities from a kotlin script file, you can test changes like so:

1. Set the version in `gradle.properties`, such as `2.5.0-LOCAL1`.

2. Run `./gradlew publishToMavenLocal` to publish the current version to your local maven repository.

3. In your script file, add the local repository and update the version:

    ```kotlin

    @file:Repository("file:///Users/{username}/.m2/repository")

    @file:DependsOn("com.slack.cli:kotlin-cli-util:{version you set in gradle.properties}")

    ```

4. Repeat as needed while testing, incrementing the version number each time to avoid caching issues.

License

--------

    Copyright 2022 Slack Technologies, LLC

    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.

[snap]: https://oss.sonatype.org/content/repositories/snapshots/com/slack/cli/