Skip to content

Commit

Permalink
doc: enhance usage information and document connection to BloodHound …
Browse files Browse the repository at this point in the history
…Enterprise
  • Loading branch information
ddlees committed Nov 16, 2022
1 parent e00a40d commit 33bb4f0
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 4 deletions.
28 changes: 25 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,33 @@ To build this project from source run the following:
go build -ldflags="-s -w -X github.com/bloodhoundad/azurehound/constants.Version=`git describe tags --exact-match 2> /dev/null || git rev-parse HEAD`"
```

## CLI
## Usage

### Quickstart

**Print all Azure Tenant data to stdout**
``` sh
❯ azurehound list -u "$USERNAME" -p "$PASSWORD" -t "$TENANT"
```

**Print all Azure Tenant data to file**
``` sh
❯ azurehound list -u "$USERNAME" -p "$PASSWORD" -t "$TENANT" -o "mytenant.json"
```

**Configure and start data collection service for BloodHound Enterprise**
``` sh
❯ azurehound configure
(follow prompts)

❯ azurehound start
```

### CLI

```
❯ azurehound --help
AzureHound v1.1.2
AzureHound vx.x.x
Created by the BloodHound Enterprise team - https://bloodhoundenterprise.io
The official tool for collecting Azure data for BloodHound and BloodHound Enterprise
Expand All @@ -50,7 +72,7 @@ Available Commands:
configure Configure AzureHound
help Help about any command
list Lists Azure Objects
start Start Azure data collection
start Start Azure data collection service for BloodHound Enterprise
Flags:
-c, --config string AzureHound configuration file (default: /Users/dlees/.config/azurehound/config.json)
Expand Down
2 changes: 1 addition & 1 deletion cmd/start.go
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ func init() {

var startCmd = &cobra.Command{
Use: "start",
Short: "Start Azure data collection",
Short: "Start Azure data collection service for BloodHound Enterprise",
Run: startCmdImpl,
PersistentPreRunE: persistentPreRunE,
SilenceUsage: true,
Expand Down

0 comments on commit 33bb4f0

Please sign in to comment.