Skip to content

GETTING_STARTED.md

Latest commit

 

History

History
61 lines (42 loc) · 1.13 KB

GETTING_STARTED.md

File metadata and controls

61 lines (42 loc) · 1.13 KB
Raw

Getting Started

Use this quick guide to run linti on your first TM1 process file.

Before you start, make sure you have at least one supported process file. See supported formats in README.md.

1. Install Python

Install Python 3.10 or higher and verify it is available in your terminal.

python --version

2. Install linti via pip

pip install linti

3. Run linti on your file

linti my-process.ti

You can also lint other supported formats (YAML, Git JSON+TI, PA-code .ti) listed in the README.

4. Auto-fix or customize rules

Try auto-fix:

linti my-process.ti --auto-fix

Or if you are not happy with the linting issues, create a linti.yaml and configure your preferred rules and settings.

For full rule explanations and configuration examples, see ALL_RULES.md.

Example:

rules:
  keyword_casing:
    enabled: true
    style: uppercase
  indentation:
    enabled: true
    size: 4
  variable_prefix:
    enabled: true
    allow_constant_prefix: false

Then run again:

linti my-process.ti --config linti.yaml