more-clink-completions (v2)

Contributions are highly welcome!

1. What is it?
2. Installation
3. License

What is it?

This repository contains Windows command line auto-completion functions to be used with chrisant996's awesome clink fork.

The completions are programmed in the strictly typed programming language Haxe and transpiled to Lua.

Currently completions for the following commands are available:

• Act.hx for act command - nektos/act local GitHub actions runner.
• Curl.hx for curl command - cURL HTTP command line client
• Dart.hx for dart command - Dart compiler
• Docker.hx for docker command - Docker command line client
• DockerMachine.hx for docker-machine command - Docker Machine command line client
• Haxe.hx for haxe command - Haxe compiler
• Java.hx for java command - Java runtime
• JavaC.hx for javac command - Java compiler
• Lua.hx for lua command - Lua interpreter
• Maven.hx for mvn command - Apache Maven build tool
• OpenSSL.hx for openssl command - OpenSSL command line tool

You need other completions? Try https://github.com/vladimir-kotikov/clink-completions

You want to create your own completions ...

• using Lua? Read https://chrisant996.github.io/clink/clink.html#extending-clink
• using Haxe? Use https://github.com/vegardit/haxe-clink-externs

Installation

1. Installing clink

Install clink according to https://chrisant996.github.io/clink/clink.html#usage, e.g.

1. Open a Windows command prompt
2. Download and install the latest clink release from https://github.com/chrisant996/clink/releases
3. Load clink using [CLINK_INSTALL_DIR]\clink.bat inject

2. Install more-clink-completions

1. Using git

   1. Open a Windows command prompt
   2. Git clone the v2-releases branch, .e.g

      git clone https://github.com/sebthom/more-clink-completions --branch v2-releases --single-branch [REPO_PATH]
      

   3. Run

      clink installscripts "[REPO_PATH]" to load the auto-completion scripts
      

2. Using curl or manual download

   1. Open a Windows command prompt
   2. Download the latest version of more-clink-completions.lua, via the Browser or via the command line e.g.

      curl -o "[DOWNLOAD_DIR]\more-clink-completions.lua" https://github.com/sebthom/more-clink-completions/releases/download/latest-v2/more-clink-completions.lua
      

   3. Register the completions with clink using

      clink installscripts "[DOWNLOAD_DIR]"
      

License

All files are released under the MIT License.

Individual files contain the following tag instead of the full license text:

SPDX-License-Identifier: MIT

This enables machine processing of license information based on the SPDX License Identifiers that are available here: https://spdx.org/licenses/.

An exception is made for:

1. files in readable text which contain their own license information, or
2. files in a directory containing a separate LICENSE.txt file, or
3. files where an accompanying file exists in the same directory with a .LICENSE.txt suffix added to the base-name of the original file. For example foobar.js is may be accompanied by a foobar.LICENSE.txt license file.