Skip to content

Commit 4634690

Browse files
Reorganize installation: download binary first, collapsible alternatives
1 parent 2d0ac2d commit 4634690

1 file changed

Lines changed: 32 additions & 28 deletions

File tree

README.md

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -90,60 +90,64 @@ tlsanalyzer example.com --format cbom -o crypto-inventory.json
9090

9191
## Installation
9292

93-
### macOS / Linux (Recommended)
93+
### Option 1: Download Binary (Easiest)
9494

95-
Copy and paste this entire block into your terminal:
95+
Download the latest release for your platform from [**Releases**](https://github.com/csnp/qramm-tls-analyzer/releases):
96+
97+
| Platform | File |
98+
|----------|------|
99+
| macOS (Apple Silicon) | `tlsanalyzer-darwin-arm64.tar.gz` |
100+
| macOS (Intel) | `tlsanalyzer-darwin-amd64.tar.gz` |
101+
| Linux | `tlsanalyzer-linux-amd64.tar.gz` |
102+
| Windows | `tlsanalyzer-windows-amd64.zip` |
103+
104+
Then extract and run:
105+
106+
```bash
107+
# macOS/Linux
108+
tar -xzf tlsanalyzer-*.tar.gz
109+
sudo mv tlsanalyzer /usr/local/bin/
110+
tlsanalyzer --version
111+
```
112+
113+
### Option 2: Build from Source
114+
115+
**Requires Go 1.21+** ([install Go](https://go.dev/dl/))
116+
117+
Copy and paste this entire block:
96118

97119
```bash
98-
# Download, build, and install (requires Go 1.21+)
99120
git clone https://github.com/csnp/qramm-tls-analyzer.git
100121
cd qramm-tls-analyzer
101122
go build -o tlsanalyzer ./cmd/tlsanalyzer
102123
sudo mv tlsanalyzer /usr/local/bin/
103124
cd .. && rm -rf qramm-tls-analyzer
104-
```
105-
106-
Verify it works:
107-
```bash
108125
tlsanalyzer --version
109126
```
110127

111-
### macOS / Linux (Alternative - No sudo)
112-
113-
If you don't have sudo access:
128+
<details>
129+
<summary>Alternative: Install without sudo</summary>
114130

115131
```bash
116132
git clone https://github.com/csnp/qramm-tls-analyzer.git
117133
cd qramm-tls-analyzer
118134
go build -o tlsanalyzer ./cmd/tlsanalyzer
119135
mkdir -p ~/bin && mv tlsanalyzer ~/bin/
120-
echo 'export PATH="$HOME/bin:$PATH"' >> ~/.zshrc # or ~/.bashrc for bash
136+
echo 'export PATH="$HOME/bin:$PATH"' >> ~/.zshrc
121137
source ~/.zshrc
122138
```
139+
</details>
123140

124-
### Windows
141+
<details>
142+
<summary>Windows (PowerShell)</summary>
125143

126144
```powershell
127145
git clone https://github.com/csnp/qramm-tls-analyzer.git
128146
cd qramm-tls-analyzer
129147
go build -o tlsanalyzer.exe ./cmd/tlsanalyzer
130-
# Move tlsanalyzer.exe to a folder in your PATH, or run from current directory
148+
# Move tlsanalyzer.exe to a folder in your PATH
131149
```
132-
133-
### Don't have Go installed?
134-
135-
**macOS:** `brew install go`
136-
137-
**Ubuntu/Debian:** `sudo apt install golang-go`
138-
139-
**Windows:** Download from https://go.dev/dl/
140-
141-
### Pre-built Binaries
142-
143-
Download from [Releases](https://github.com/csnp/qramm-tls-analyzer/releases) for:
144-
- Linux (amd64, arm64)
145-
- macOS (amd64, arm64)
146-
- Windows (amd64)
150+
</details>
147151

148152
## Usage
149153

0 commit comments

Comments
 (0)