-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4b628ad
commit 8f3231e
Showing
1 changed file
with
45 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,46 @@ | ||
# Lava | ||
|
||
Lava is an open source vulnerability scanner that makes it easy to run | ||
security checks in your local and CI/CD environments. | ||
|
||
Lava is part of the [Vulcan ecosystem][vulcan-docs] and it is built on | ||
top of the same components that power Vulcan. | ||
Thus, Lava continuously benefits from Vulcan improvements. | ||
In fact, Lava is compatible with the [vulcan-checks][vulcan-checks] | ||
catalog shipped with Vulcan. | ||
|
||
## Install | ||
|
||
### Install From Source | ||
|
||
Install the Lava command with `go install`: | ||
|
||
``` | ||
go install github.com/adevinta/lava/cmd/lava@latest | ||
``` | ||
|
||
### GitHub Actions | ||
|
||
Lava is also available as an action that can be used from GitHub | ||
Actions workflows. | ||
Visit [adevinta/lava-action][lava-action] for usage instructions. | ||
|
||
## Documentation | ||
|
||
Lava is self-documented. | ||
Please run `lava help` to get more information about the available | ||
commands and other related topics. | ||
|
||
## Contributing | ||
|
||
**This project is in an early stage, we are not accepting external | ||
contributions yet.** | ||
|
||
To contribute, please read the [contribution | ||
guidelines][contributing]. | ||
|
||
|
||
[vulcan-docs]: https://adevinta.github.io/vulcan-docs | ||
[vulcan-checks]: https://github.com/adevinta/vulcan-checks | ||
[lava-action]: https://github.com/adevinta/lava-action | ||
[contributing]: /CONTRIBUTING.md |