ncaic v0.5.2

NCAIC CLI Toolkit

A collection of tools for NCAIC competitors.

Installation

There are multiple ways to use the toolkit.

Install globally by using NPM

Requirements: Node.js

This method only install the toolkit, without any language support (but JS support should be already satisfied).

npm i -g ncaic

You can then use ncaic check to check the language support on your system.

Directly run from npx or pnpm dlx

Requirements: Node.js, PNPM (optional)

You can also run it directly using a single npx or pnpm dlx command.

npx -y ncaic

or

pnpm dlx ncaic

Using Docker Image

Requirements: Docker

This methods provides a Docker image including the toolkit and all the language support.

docker run --rm jacoblincool/ncaic

You can run command like this:

docker run --rm jacoblincool/ncaic check

If you want to run the local server, you will need to bind both volume and port.

docker run --rm -v "$(pwd)/config.yml:/app/config.yml" -p 52022:52022 -it jacoblincool/ncaic run

or using -e to expose a secure tunnel.

docker run --rm -v "$(pwd)/config.yml:/app/config.yml" -it jacoblincool/ncaic run -e

Understand what -v and -p do: https://docs.docker.com/engine/reference/commandline/run/#options

Note: Images are hosted on Docker Hub: jacoblincool/ncaic

Commands

Checkout the help menu

ncaic --help

You can use ncaic <command> --help to get the help for a specific command.

Check the language support on your system

ncaic check

Verify the team.json file

ncaic verify

Test the agent program

ncaic test

Create and initialize a config file

ncaic init

Run the local competition server

ncaic run

Run a performance test

It is useful to find the performance gap between your computer and the competition server.

ncaic perf