sebthom/more-clink-completions

Windows command line Clink auto-completion for Nektos/Act, Curl, Docker, Dart, Haxe, Java, Lua, Maven, OpenSSL

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.

more-clink-completions's Issues

Fix the incorrect branch name in the installation instructions in README.md

This command results in error as the branch is called v2-releases and not v2-release:

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

Hence, the correct command should be:
git clone https://github.com/sebthom/more-clink-completions --branch v2-releases --single-branch [REPO_PATH]

docker.lua prevents the use of the `--name` flag

I want to try to run the following docker command

docker run -d --name kroki --restart unless-stopped -p29000:8000 yuzutech/kroki

But I can't run the command because i'm interrupted by the error message

unknown flag: --name
See 'docker --help'.

Usage:  docker [OPTIONS] COMMAND

A self-sufficient runtime for containers

As soon as I enter the --name flag

Error more-clink-completions.lua:6: attempt to call field 'getargmatcher' (a nil value)

I have clink v1.2.41.647c1b installed.
Installed more-clink-completions:

git clone https://github.com/sebthom/more-clink-completions --branch v2-releases --single-branch d:\utils\clink\completions\more-clink-completions

and got message:

`Script path 'd:\utils\clink\completions\more-clink-completions' installed.

...etions\more-clink-completions\more-clink-completions.lua:6: attempt to call field 'getargmatcher' (a nil value)
stack traceback:
...etions\more-clink-completions\more-clink-completions.lua:6: in function 'register'
...etions\more-clink-completions\more-clink-completions.lua:6: in function 'main'
...etions\more-clink-completions\more-clink-completions.lua:6: in function <...etions\more-clink-completions\more-clink-completions.lua:6>
[C]: in function 'xpcall'
...etions\more-clink-completions\more-clink-completions.lua:6: in function 'luapack_entry'
...etions\more-clink-completions\more-clink-completions.lua:6: in main chunk`

This message arises each time I start cmd.exe.
Completions isn't working.
I don't have any other clink scripts installed.

My OS is Windows x64 v10.0.19045 build 19045.
If you need more info about my PC/OS, please let me know.

Errors raised by docker.kua

When writing docker commands, I am getting:

$ docker inspect
match generator failed:
C:\Repository\more-clink-completions\src\docker.lua:41: attempt to call field 'misses_key' (a nil value)
stack traceback:
        C:\Repository\more-clink-completions\src\docker.lua:41: in function <C:\Repository\more-clink-completions\src\docker.lua:40>
        ?: in function <?:1457>
        ?: in function '_generate'
        ?: in function <?:2237>
        (...tail calls...)
        ?: in function <?:217>
        [C]: in function 'xpcall'
        ?: in function '_generate'
        ?: in function <?:142>

"docker inspect" requires at least 1 argument.
See 'docker inspect --help'.

Usage:  docker inspect [OPTIONS] NAME|ID [NAME|ID...]

Return low-level information on Docker objects