Cianity Command Line Tool

The cianity command line tool contains everything there is to work with ciane workflows.

Default workflow

Cianity will look for a file called workflow.ci (or .workflow.ci as a second choice) in the current directory and then going up towards the root of the file system.

In this case, no file needs to be specified. The rest of this guide will assume that a workflow.ci file is used.

Most commands also accept -w/--workspace to specify a different workflow root.

Check (lint)

To check the validity of a workflow use the check command.

cianity check

As well as ensuring that the workflow can be built, a few other warning lints are also checked.

Format

To format files, use the format command.

cianity format

To validate that a workspace has already been formatted (on CI for example), use the --check flag.

cianity format --check

There is no configuration for the formatting. It is what it is.

Build

It is currently possible to build a ciane workflow to a GitLab pipeline.

cianity build -t gitlab

By default this will result in a .gitlab-ci.yml file which is picked up by GitLab by default.

To specify a different output file, use the -o flag.

cianity build -t gitlab -o main.gitlab-ci.yml

In order to check that the built pipeline is up to date with the ciane workflow, the --check flag can be used. It is recommended that this is used on CI to make sure that both checked in files match.

cianity build -t gitlab -o main.gitlab-ci.yml --check

LSP

Cianity comes with a built in LSP, just like a grown up programming language.

cianity lsp

The lsp sub-command will also accept the --stdio flag which some IDEs pass unconditionally. This changes nothing as the cianity LSP only works over stdin/out.

Help!

Use the -h flag or the help sub-command to see available sub-commands. The -h flag can be used with sub-commands to see all available flags.