Release/1.3.8 (#40)

* bump up version code

* bring back installer script guide in README.md

* docs: update README.md to mention install.sh env vars

* added new install.sh env vars to agents.sh

* Feat/telemetry (#39)

* add no-telemetry cli flag and toml config flag. read and call telemetry if false

* send analytics in telemetry.Send

* added telemetry message

* read/write telemetry.json file

* fixed cli-flags test

* added tests for telemetry

* docs: updated changelog

* docs: added telemetry to README.md

* removed debug prints

* send telemetry in CI

* use NoTelemetry instead of Debug in cli-flag test

* fix no-telemetry flag name

* fix: send erro when not nil

* fix test error

* send ci to analytics

* docs: updated changelog

* docs: added 1.3.8 release notes

* added 1.3.8-alpha release notes to 1.3.8

* fix typos, handle error state

Author: mabd-dev

AGENTS.md

@@ -15,6 +15,10 @@ go build -o reposcan .
 
 # Install
 curl -fsSL https://raw.githubusercontent.com/mabd-dev/reposcan/main/install.sh | sh
+
+# VERSION: is optional with default value='latests'
+# ALIAS: is optional with default value='reposcan'
+curl -fsSL https://raw.githubusercontent.com/mabd-dev/reposcan/main/install.sh | VERSION=v1.3.8 ALIAS=reposcan sh 
 ```
 
 ### Testing

CHANGELOG.md

@@ -6,7 +6,22 @@ All notable changes to this project will be documented in this file.
 ## Unreleased
 
 
-## [1.3.8] - 2026-04-27
+## [1.3.8] - 2026-05-21
+
+### Added
+
+- feat(telemetry): send anonymous telemetry usage by @mabd-dev in [#39](https://github.com/mabd-dev/reposcan/pull/39)
+- feat(release): release workflow and install.sh by @AnthonyGeorgeAZ in [#30](https://github.com/mabd-dev/reposcan/pull/30)
+- feat(analytics): add Analytics interface with Mixpanel and stdout backends by @mvanhorn in [#27](https://github.com/mabd-dev/reposcan/pull/27)
+- feat(changelog): add CHANGELOG.md by @vgauraha62 in [#26](https://github.com/mabd-dev/reposcan/pull/26)
+
+### Fixed
+
+- fix: hide redundant remote name in state column by @mvanhorn in [#23](https://github.com/mabd-dev/reposcan/pull/23)
+
+---
+
+## [1.3.8-alpha] - 2026-04-27
 
 ### Added
 

README.md

@@ -32,14 +32,55 @@ https://github.com/user-attachments/assets/1c8370c6-3b94-4490-bc96-fc179ef14f1d
 
 ## 📦 Installation
 
-### Go install (latest)
+### Install script (recommended)
+
+The easiest way to install `reposcan`. Detects your OS and architecture automatically and installs the latest release binary into a directory on your `$PATH`:
+
+```sh
+curl -fsSL https://raw.githubusercontent.com/mabd-dev/reposcan/main/install.sh | sh
+```
+
+Supports **linux/amd64**, **darwin/amd64**, and **darwin/arm64**.
+
+
+#### Install environment variables
+
+| env vars | Required | Default | Description |
+|---|---|---|---|
+| `VERSION` | false | latest | download a specific version |
+| `ALIAS` | false | reposcan | specify binary name |
+
+```sh
+# with version
+curl -fsSL https://raw.githubusercontent.com/mabd-dev/reposcan/main/install.sh | VERSION=v1.3.8 sh
+```
+
+```sh
+# with alias
+curl -fsSL https://raw.githubusercontent.com/mabd-dev/reposcan/main/install.sh | ALIAS=reposcan sh
+```
+
+```sh
+# with both
+curl -fsSL https://raw.githubusercontent.com/mabd-dev/reposcan/main/install.sh | VERSION=v1.3.8 ALIAS=reposcan sh
+```
+
+
+#### Migrating from `go install`
+
+If you previously installed reposcan via `go install`, the binary lives in `$GOPATH/bin` (usually `~/go/bin/reposcan`). The curl installer puts the binary in a different location, so both can coexist silently — meaning the old one may take precedence in your `$PATH`.
+
+To avoid this, remove the old binary first:
 
 ```sh
-go install github.com/mabd-dev/reposcan@latest
+rm "$(which reposcan)"
 ```
 
-Make sure # $GOPATH/bin (or $HOME/go/bin) is in your $PATH
+Then install using the curl installer:
 
+```sh
+curl -fsSL https://raw.githubusercontent.com/mabd-dev/reposcan/main/install.sh | sh
+```
 
 ### From source
 ```sh
@@ -134,5 +175,27 @@ Each step overrides the one before it
 - [ ] Show branches with their states on each repo
 
 
+## Telemetry
+
+reposcan collects anonymous usage data to help understand how the tool is used and improve it over time.
+You'll see a one-time notice about this on first run.
+
+What is collected:
+- `os` — operating system (linux, windows, darwin)
+- `arch` — device cpu architecture 
+- `tool-version` — tool version being used
+- `ci` — whether the tool is running in a CI environment
+
+and other tool specific cli-flags like `filter`, `output_format`, `repo_count`
+
+Nothing personal is collected — no usernames, tokens, or file paths.
+Events are sent to a [mixpanel](https://mixpanel.com/home/) (a third-party analytics service) and visible only to the maintainer.
+
+
+### Disable telemetry
+
+Add `--no-telemetry` when running the command. Or in `~/.config/reposcan/config.toml` add `no-telemetry = true` at the top of the file (check [sample.toml](sample/config.toml))
+
+
 ## 🤝 Contributing
 PRs, bug reports, and feature requests are welcome.

cmd/reposcan/flags_read_test.go

@@ -20,6 +20,7 @@ func TestReadFlags_AppliesAllFlags(t *testing.T) {
 	cmd.Flags().String("json-output-path", "", "")
 	cmd.Flags().IntP("max-workers", "w", 8, "")
 	cmd.Flags().BoolP("debug", "", false, "")
+	cmd.Flags().BoolP("no-telemetry", "", false, "")
 	// cmd.Flags().StringP("colorscheme", "", "", "")
 
 	args := []string{
@@ -31,7 +32,8 @@ func TestReadFlags_AppliesAllFlags(t *testing.T) {
 		"-f", "all",
 		"--json-output-path", "/tmp/out",
 		"-w", "16",
-		"--debug", "true",
+		"--debug=true",
+		"--no-telemetry=false",
 		// "--colorscheme", "something",
 	}
 	cmd.SetArgs(args)
@@ -66,7 +68,10 @@ func TestReadFlags_AppliesAllFlags(t *testing.T) {
 		t.Fatalf("max workers not applied: %d", cfg.MaxWorkers)
 	}
 	if cfg.Debug != true {
-		t.Fatalf("debugnot applied: %t", cfg.Debug)
+		t.Fatalf("debug not applied: %t", cfg.Debug)
+	}
+	if cfg.NoTelemetry != false {
+		t.Fatalf("telemetry not applied: %t", cfg.NoTelemetry)
 	}
 }
 
@@ -92,6 +97,7 @@ func TestReadTableOutput_SwitchToInteractiveOutput(t *testing.T) {
 	cmd.Flags().String("json-output-path", "", "")
 	cmd.Flags().IntP("max-workers", "w", 8, "")
 	cmd.Flags().BoolP("debug", "", false, "")
+	cmd.Flags().BoolP("no-telemetry", "", false, "")
 	// cmd.Flags().StringP("colorscheme", "", "", "")
 
 	args := []string{
@@ -103,7 +109,8 @@ func TestReadTableOutput_SwitchToInteractiveOutput(t *testing.T) {
 		"-f", "all",
 		"--json-output-path", "/tmp/out",
 		"-w", "16",
-		"--debug", "true",
+		"--debug=true",
+		"--no-telemetry=false",
 		// "--colorscheme", "something",
 	}
 	cmd.SetArgs(args)

cmd/reposcan/main.go

@@ -39,6 +39,7 @@ func init() {
 	RootCmd.PersistentFlags().String("json-output-path", configs.Output.JSONPath, "Write scan report JSON files to this directory (optional)")
 	RootCmd.PersistentFlags().IntP("max-workers", "w", configs.MaxWorkers, "Number of concurrent git checks")
 	RootCmd.PersistentFlags().BoolP("debug", "", configs.Debug, "Enable/Disable debug mode")
+	RootCmd.PersistentFlags().BoolP("no-telemetry", "", configs.NoTelemetry, "Enable/Disable sending telemetry")
 	// RootCmd.PersistentFlags().StringP("colorscheme", "", configs.Output.ColorSchemeName, "Used only if 'output' is 'interactive'")
 
 	RootCmd.AddCommand(versionCmd)

cmd/reposcan/rootCmd.go

@@ -12,6 +12,7 @@ import (
 	"github.com/mabd-dev/reposcan/internal/render/file"
 	"github.com/mabd-dev/reposcan/internal/render/stdout"
 	"github.com/mabd-dev/reposcan/internal/render/tui"
+	"github.com/mabd-dev/reposcan/internal/telemetry"
 	"github.com/spf13/cobra"
 )
 
@@ -72,6 +73,7 @@ var RootCmd = &cobra.Command{
 //   - max-workers (-w)     		: number of concurrent git checks
 //   - debug (--debug)      		: enable/disable debug mode
 //   - colorscheme (--colorscheme)  : enable/disable debug mode
+//   - no-telemetry					: enable/disable sending telemetry data
 func readFlags(cmd *cobra.Command, configs *config.Config) error {
 	// Read roots flags
 	roots, err := cmd.Flags().GetStringArray("root")
@@ -138,12 +140,22 @@ func readFlags(cmd *cobra.Command, configs *config.Config) error {
 	}
 	(*configs).Debug = debug
 
+	noTelemetry, err := cmd.Flags().GetBool("no-telemetry")
+	if err != nil {
+		return err
+	}
+	(*configs).NoTelemetry = noTelemetry
+
 	return nil
 }
 
 func run(configs config.Config) error {
 	report := internal.GenerateScanReport(configs)
 
+	if !configs.NoTelemetry {
+		telemetry.Send(mixpanelToken, configs.Debug, configs.Only, configs.Output.Type, len(report.RepoStates))
+	}
+
 	switch configs.Output.Type {
 	case config.OutputJson:
 		err := stdout.RenderScanReportAsJson(report)

docs/cli-flags.md

@@ -60,3 +60,8 @@ This document explains each CLI flag, its equivalent `config.toml` field, what i
   - Config: `debug = true/false`
   - Description: Enable/disable logging mode. Log file will be in `~/.config/reposcan/logs/`
   - Example: `--debug=false` or `--debug` same as `--debug=true`
+
+- `--no-telemetry true/false`
+  - Config: `no-telemetry = true/false`
+  - Description: Enable/disable sending telemetry data
+  - Example: `--no-telemetry=true` or `--no-telemetry`

go.mod

@@ -8,6 +8,7 @@ require (
 	github.com/charmbracelet/bubbletea v1.3.6
 	github.com/charmbracelet/lipgloss v1.1.0
 	github.com/fatih/color v1.18.0
+	github.com/google/uuid v1.6.0
 	github.com/mattn/go-runewidth v0.0.16
 	github.com/mixpanel/mixpanel-go v1.2.1
 	github.com/muesli/reflow v0.3.0

go.sum

@@ -29,6 +29,8 @@ github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f h1:Y/CXytFA4m6
 github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f/go.mod h1:vw97MGsxSvLiUE2X8qFplwetxpGLQrlU1Q9AUEIzCaM=
 github.com/fatih/color v1.18.0 h1:S8gINlzdQ840/4pfAwic/ZE0djQEH3wM94VfqLTZcOM=
 github.com/fatih/color v1.18.0/go.mod h1:4FelSpRwEGDpQ12mAdzqdOukCy4u8WUtOY6lkT/6HfU=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
 github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
 github.com/jarcoal/httpmock v1.3.1 h1:iUx3whfZWVf3jT01hQTO/Eo5sAYtB2/rqaUuOtpInww=

internal/config/types.go

@@ -15,7 +15,8 @@ type Config struct {
 	MaxWorkers int `toml:"maxWorkers"`
 
 	// Debug if true, enable logging to a file in [DefaultLogFileDir]
-	Debug bool `toml:"debug"`
+	Debug       bool `toml:"debug"`
+	NoTelemetry bool `toml:"no-telemetry"`
 
 	Version int `toml:"version"`
 }