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
2 changes: 2 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,3 +9,5 @@ updates:
directory: "/"
schedule:
interval: "weekly"
exclude-paths:
- "e2e/fixtures/**"
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
steps:
- uses: actions/checkout@v5
- name: Setup Biome CLI
uses: biomejs/setup-biome@a9763ed3d2388f5746f9dc3e1a55df7f4609bc89 # v2.5.1
uses: biomejs/setup-biome@454fa0d884737805f48d7dc236c1761a0ac3cc13 # v2.6.0
- name: Run Biome
run: biome ci

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/manual-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ jobs:

# S3 Distribution
- name: Configure AWS credentials
uses: aws-actions/configure-aws-credentials@v4
uses: aws-actions/configure-aws-credentials@v5
with:
aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
Expand Down
44 changes: 36 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,40 @@ The HeroDevs CLI
* [@herodevs/cli](#herodevscli)
<!-- tocstop -->

## Installation Instructions
### Prerequisites

1. Install node v20 or higher: [Download Node](https://nodejs.org/en/download)
1. Install the CLI using one of the following methods:
* Globally: Refer to the [Usage](#usage) instructions on installing the CLI globally
* npx: `npx @herodevs/cli@beta`
1. Refer to the [Commands](#commands) section for a list of commands
- Install node v20 or higher: [Download Node](https://nodejs.org/en/download)
- The HeroDevs CLI expects that you have all required technology installed for the project that you are running the CLI against
- For example, if you are running the CLI against a Gradle project, the CLI expects you to have Java installed.


### Installation methods

#### Node Package Execute (NPX)

With Node installed, you can run the CLI directly from the npm registry without installing it globally or locally on your system

```sh
npx @herodevs/cli@beta
```

#### Global NPM Installation

```sh
npm install -g @herodevs/cli@beta
```

#### Binary Installation

HeroDevs CLI is available as a binary installation, without requiring `npm`. To do that, you may either download and run the script manually, or use the following cURL or Wget command:

```sh
curl -o- https://raw.githubusercontent.com/herodevs/cli/v2.0.0-beta.8/scripts/install.sh | bash
```

```sh
wget -qO- https://raw.githubusercontent.com/herodevs/cli/v2.0.0-beta.8/scripts/install.sh | bash
```

## TERMS

Expand Down Expand Up @@ -56,7 +83,7 @@ USAGE
* [`hd help [COMMAND]`](#hd-help-command)
* [`hd scan eol`](#hd-scan-eol)
* [`hd update [CHANNEL]`](#hd-update-channel)
* Only applies to tarball installation. For NPM users, please update using `npm install`
* **NOTE:** Only applies to [binary installation method](#binary-installation). NPM users should use [`npm install`](#global-npm-installation) to update to the latest version.

## `hd help [COMMAND]`

Expand Down Expand Up @@ -126,7 +153,8 @@ _See code: [src/commands/scan/eol.ts](https://github.com/herodevs/cli/blob/v2.0.
## `hd update [CHANNEL]`

update the hd CLI
**NOTE:** Only applies to binary installation method. NPM users should use `npm install` to update to the latest version.

* **NOTE:** Only applies to [binary installation method](#binary-installation). NPM users should use [`npm install`](#global-npm-installation) to update to the latest version.

```
USAGE
Expand Down
Loading
Loading