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-output/index.mdx
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,16 +17,15 @@ The output of the command will display the results of each policy in the group,
17
17
For example, when using the run command with a Group that includes the `Prettier` and `ESLint` policies, the output will show the results for each policy in the group.
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 Group, where can organize and manage different policies, and then run them as a group.
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 groups [here](setup/groups).
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 run
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 Group scan on your repository
76
+
### 2. Run an Exlint Group scan on your repository
67
77
68
78
To use a group, 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 <group_id>
81
+
```bash
82
+
exlint use <group_id>
83
+
```
72
84
73
85
Run a group 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