enki

Command-line validation tool.

Installation

1. Clone the repository:

   git clone https://github.com/Levi-Leah/enki.git

2. Navigate to the root directory of the repository:

   cd enki

3. Run the installation script:

   sh install.sh

4. Source your ~/.bashrc file:

   source ~/.bashrc

Verification steps

• To verify that enki is installed, run:

  enki -h

Usage

• To see the help message, run:

  enki -h

• To validate the files, run:

  enki validate <PATH>

  Replace <PATH> with the path to files or directories you want to validate.

• To print one validation error per line, run:

  enki validate --oneline <PATH>

  Replace <PATH> with the path to files or directories you want to validate.

• To validate the links, run:

  enki validate --links <PATH>

  Note Validation can only be performed on master.adoc files.

Note enki does not descend into symlinks.

Examples

• To validate all files in the directory, run:

  enki validate path/

• To validate a specific file or files, run:

  enki validate path/to/file.adoc

• To validate all files that match a global pattern, run:

  enki validate path/to/**/**/*adoc

• To validate all files that match the special character, run:

  enki validate path/to/*adoc

• To validate files and print one validation error per line, run:

  enki validate --oneline path/to/*adoc

• To validate links, run:

  enki validate --links path/to/dir/

Error messages

enki has the following errors:

• enki errors
• validation errors
• link errors

enki errors

enki errors occur when enki is unable to perform the validation.

For more information, see enki error messages.

Validation errors

Validation errors occur when the files you are validating did not pass the validation checks.

For more information, see validation error messages.

Link errors

Link errors occur when the link can not be resolved.

For more information, see link error messages.

Reporting a bug

Issue tracker

License

MIT