Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Contributors

A huge thank you to all the people who have contributed to vet! This project would not be the same without your help.

## Core Contributions & Ideas

* **[@smartwatermelon](https://github.com/smartwatermelon)** - Provided the initial concept and working formula for the Homebrew distribution, a key feature for macOS and Linux users.

*(If you have contributed to the project, please feel free to open a pull request to add your name!)*
25 changes: 21 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,24 @@ vet https://example.com/install.sh

## Installation

We believe you should never blindly trust a script from the internet—not even ours. That's why `vet` exists. The installation process itself is a perfect demonstration of the problem vet solves.
We believe you should never blindly trust a script from the internet—not even ours. That's why `vet` exists. The installation process itself is a perfect demonstration of the problem `vet` solves.

### The Safe Way (Recommended)
## Homebrew (macOS/Linux) - Recommended

This is the two-step "Download, then Review" process that vet automates.
The easiest and recommended way to install `vet` is via Homebrew.
```
# First, tap the official repository
brew tap vet-run/vet

# Now, install the formula
brew install vet-run
```
**Note:** The formula is named `vet-run` to avoid a conflict with another tool in the Homebrew ecosystem, but this command will correctly install the `vet` executable on your system.

## Manual Installation

### The Safe Way
If you don't use Homebrew, or if you simply wish to follow the security-first principle that `vet` champions, you can perform a manual installation. This is the two-step "Download, then Review" process that demonstrates exactly what `vet` automates for you.

1. **Download the installer**:

Expand All @@ -65,7 +78,7 @@ bash install_vet.sh

Congratulations! You just manually performed the process that vet will now automate for you.

### The "Trusting" One-Liner
### The "Trusting" One-Liner (The Anti-Pattern)
```bash
# This is the curl-to-bash pattern.
# Don't actually do this. That's the whole point.
Expand Down Expand Up @@ -128,6 +141,10 @@ Contributions are welcome! If you have an idea for a new feature or have found a

- Open a new Pull Request.

## Acknowledgements

This project is made better by its contributors. See our [Contributors](CONTRIBUTORS.md) file to recognize those who have helped shape `vet`.

## License

This project is licensed under the MIT License - see the [LICENSE](https://spdx.org/licenses/MIT.html) file for details.
45 changes: 35 additions & 10 deletions public/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
.container {
width: 100%;
max-width: 780px;
padding: 2.5rem;
padding: 2.5rem 2.5rem 7rem 2.5rem;
}
h1 {
color: #75b6ff;
Expand All @@ -30,14 +30,19 @@
h2 {
font-weight: normal;
font-size: 1rem;
color: #e4e4e4;
color: #f1f1f1;
margin-top: 0em;
margin-bottom: 1em;
font-weight: 600;
}
h3 {
margin-top: 2rem;
font-size: 1.2rem;
color: #f1f1f1;
}
h3.section {
margin-top: 1.5rem;
font-size: 1rem;
color: #e4e4e4;
}
h4 {
Expand Down Expand Up @@ -82,6 +87,15 @@
color: #6a6a6a;
font-style: italic;
}
ol {
font-size: 0.9rem;
display: block;
list-style-type: decimal;
margin-block-start: 1em;
margin-block-end: 1em;
padding-inline-start: 40px;
unicode-bidi: isolate;
}
.install-box {
background-color: #161b22;
padding: 0.6rem;
Expand All @@ -104,9 +118,11 @@
a:hover {
text-decoration: underline;
}
.footer {
.note {
margin-top: 2rem;
font-size: 0.9rem;
font-size: 0.85rem;
width: 100%;
text-align: right;
}
.ascii-header {
color: #75b6ff;
Expand All @@ -120,6 +136,9 @@
</head>
<body>
<div class="container">
<div class="note">
View the source on <a href="https://github.com/vet-run/vet">GitHub</a>
</div>
<h1>vet</h1>
<h2>Don't just run it — <code class="vet">vet</code> it.</h2>
<p>Stop blindly piping to bash. <code class="vet">vet</code> lets you inspect remote scripts for changes, run them through a linter, and require your explicit approval before they can execute.</p>
Expand All @@ -143,7 +162,17 @@ <h3>The Solution</h3>
<code>vet https://example.com/install.sh</code></pre>
</div>
<h3>Installation</h3>
<h4>The Safe Way (Recommended)</h4>
<h3 class="section">Homebrew (macOS/Linux)</h3>
<p>The easiest and recommended way to install <code class="vet">vet</code> is via Homebrew.</p>
<div class="install-box">
<pre><code class="comment"># First, tap the official repository</code>
<code>brew tap vet-run/vet</code>
<code></code>
<code class="comment"># Now, install the formula</code>
<code>brew install vet-run</code></pre>
</div>
<h3 class="section">Manual Installation</h3>
<h4>The Safe Way</h4>
<p>This is the two-step "Download, then Review" process that <code class="vet">vet</code> automates.</p>
<ol>
<li>
Expand Down Expand Up @@ -172,16 +201,12 @@ <h4>The Safe Way (Recommended)</h4>
</li>
</ol>
<p>Congratulations! You just manually performed the process that <code class="vet">vet</code> will now automate for you.</p>
<h4>The "Trusting" One-Liner</h4>
<h4>The "Trusting" One-Liner (The Anti-Pattern)</h4>
<p>In your terminal, run:</p>
<div class="install-box">
<pre><code class="comment"># Don't actually do this. That's the whole point.</code>
<code>curl -sL https://getvet.sh/install.sh | sh</code></pre>
</div>

<div class="footer">
➤ View the source on <a href="https://github.com/vet-run/vet">GitHub</a>
</div>
</div>
</body>
</html>