You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/setup/cli-argument/index.mdx
+12Lines changed: 12 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,12 +11,24 @@ import styles from './styles.module.css';
11
11
12
12
Exlint's command-line interface (CLI) allows you to run Exlint on your codebase from the command line. The following arguments are available:
13
13
14
+
#### Usage commands:
15
+
14
16
`auth`: This argument is used to authenticate your Exlint account. You will be prompted to enter your API key.
15
17
16
18
`use`: This argument is used to specify the compliance you want to run Exlint on using its unique ID. The compliance ID can be found on the Exlint dashboard.
17
19
18
20
`run`: This argument is used to run Exlint on your codebase. The `--fix` or `-f` flag can be used to automatically fix any issues found by Exlint.
19
21
22
+
#### Base commands
23
+
24
+
`-v`, `--version`: This argument is used to check your Exlint CLI version.
25
+
26
+
`--env-info`: This argument is used to print system and project information.
27
+
28
+
#### Debugging
29
+
30
+
Usage commands can be debugged using the `--debug` flag.
31
+
20
32
#### Examples:
21
33
22
34
To authenticate your Exlint account, you can use the following command:
Copy file name to clipboardExpand all lines: docs/setup/cli-output/index.mdx
+5-6Lines changed: 5 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,18 +17,17 @@ The output of the command will display the results of each policy in the complia
17
17
For example, when using the run command with a Compliance that includes the `Prettier` and `ESLint` policies, the output will show the results for each policy in the compliance.
18
18
Here is an example of what the output may look like:
Copy file name to clipboardExpand all lines: docs/welcome/getting-started/index.mdx
+31-17Lines changed: 31 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,18 +29,9 @@ Exlint does not require access to code, Git provider, or any other sensitive inf
29
29
30
30
---
31
31
32
-
## Using Exlint
33
-
34
-
### 1. Centralize your compliance in Exlint
35
-
36
-
Get started by creating an account at [app.exlint.io](https://app.exlint.io).
37
-
38
-
Create your first Exlint Compliance, where can organize and manage different policies, and then run them as a compliance.
39
-
These policies are used to check your code for compliance with industry standards and best practices.
32
+
## Quickstart
40
33
41
-
Read more about configuring compliances [here](setup/compliances).
42
-
43
-
### 2. Install the Exlint CLI
34
+
### 1. Install the Exlint CLI
44
35
45
36
To install the Exlint CLI with `npm`, run one of the following commands:
46
37
@@ -57,27 +48,50 @@ To install the Exlint CLI with `npm`, run one of the following commands:
57
48
</TabItem>
58
49
</Tabs>
59
50
60
-
### 3. Connect your CLI to your Exlint Dashboard
51
+
### 2. 🚀 Run your first compliance check
52
+
53
+
Use the `go` command to quickly setup a recommended compliance and customize it in our Dashboard.
54
+
55
+
```bash
56
+
exlint go
57
+
```
58
+
59
+
Exlint will ask you for you project languages, and create a recommended compliance based on how we code at Exlint.
60
+
61
+
:::tip
62
+
Use the go command to easily get started enforcing best practices with Exlint.
63
+
You can adjust and customize the compliance for your needs, or create a new one from scratch!
64
+
:::
65
+
66
+
## Using Exlint
67
+
68
+
### 1. Connect your CLI to your Exlint Dashboard
61
69
62
70
Use the following command to authenticate with your Exlint account:
63
71
64
-
exlint auth
72
+
```bash
73
+
exlint auth
74
+
```
65
75
66
-
### 4. Run an Exlint Compliance scan on your repository
76
+
### 2. Run an Exlint Compliance scan on your repository
67
77
68
78
To use a compliance, copy its identifier and use it with the `use` command in the Exlint CLI.
69
79
This will adjust your IDE and install necessary extensions and libraries.
70
80
71
-
exlint use <compliance_id>
81
+
```bash
82
+
exlint use <compliance_id>
83
+
```
72
84
73
85
Run a compliance scan against your code using the `run` command:
74
86
75
-
exlint run [options]
87
+
```bash
88
+
exlint run [options]
89
+
```
76
90
77
91
You can also run the command with `--fix` or `-f` option.
78
92
Providing this option will make Exlint try to automatically fix code issues.
79
93
80
-
### 5. Integrate Exlint into your CI
94
+
### 3. Integrate Exlint into your CI
81
95
82
96
Keep your CI aligned with your stardartized Exlint compliance using our [GitHub Action](/ci/github-action).
83
97
Check out our [roadmap](https://github.com/orgs/Exlint/projects/3) to see which other integrations we're planning to support (or tell us if we're missing the one you like!)
0 commit comments