CompassSecurity · frjcomp · May 6, 2026 · May 6, 2026 · May 6, 2026 · May 6, 2026
diff --git a/Makefile b/Makefile
@@ -1,4 +1,4 @@
-.PHONY: help build build-all build-gitlab build-github build-bitbucket build-devops build-gitea build-circle test test-unit test-e2e lint clean coverage coverage-html serve-docs
+.PHONY: help build build-all build-gitlab build-github build-bitbucket build-devops build-gitea build-circle test test-unit test-e2e lint clean coverage coverage-html serve-docs gen-config
 
 # Default target
 help:
@@ -18,6 +18,7 @@ help:
 	@echo "  make test-e2e         - Run e2e tests (builds binary first)"
 	@echo "  make coverage         - Generate test coverage report"
 	@echo "  make coverage-html    - Generate and open HTML coverage report"
+	@echo "  make gen-config       - Generate pipeleek.example.yaml from the config gen command"
 	@echo "  make lint             - Run golangci-lint"
 	@echo "  make serve-docs       - Generate and serve CLI documentation"
 	@echo "  make clean            - Remove built artifacts"
@@ -126,6 +127,12 @@ coverage-html: coverage
 		echo "Open coverage.html in your browser to view the report"; \
 	fi
 
+# Generate pipeleek.example.yaml using the config gen command
+gen-config: build
+	@echo "Generating pipeleek.example.yaml..."
+	./pipeleek config gen --output pipeleek.example.yaml
+	@echo "pipeleek.example.yaml updated"
+
 # Run golangci-lint
 lint:
 	@echo "Running golangci-lint..."

diff --git a/docs/guides/gitlab.md b/docs/guides/gitlab.md
@@ -158,7 +158,7 @@ There are many reasons why credentials might be included in the job output. More
 [Pipeleek](https://github.com/CompassSecurity/pipeleek) can be used to scan for credentials in the job outputs.
 
 ```bash
-$ pipeleek gl scan --token glpat-[redacted] --gitlab https://gitlab.example.com -c [gitlab session cookie]]  -v -a -j 5 --confidence high-verified,high
+$ pipeleek gl scan --token glpat-[redacted] --url https://gitlab.example.com -c [gitlab session cookie]]  -v -a -j 5 --confidence high-verified,high
 2024-09-26T13:47:09+02:00 debug Verbose log output enabled
 2024-09-26T13:47:10+02:00 info Gitlab Version Check revision=2e166256199 version=17.5.0-pre
 2024-09-26T13:47:10+02:00 debug Setting up queue on disk
@@ -236,7 +236,7 @@ Runners can be attached globally, on the group level or on individual projects.
 Using pipeleek we can automate runner enumeration:
 
 ```bash
-$ pipeleek gl runners --token glpat-[redacted] --gitlab https://gitlab.example.com -v list
+$ pipeleek gl runners --token glpat-[redacted] --url https://gitlab.example.com -v list
 2024-09-26T14:26:54+02:00 info group runner description=2-green.shared-gitlab-org.runners-manager.gitlab.example.com name=comp-test-ia paused=false runner=gitlab-runner tags=gitlab-org type=instance_type
 2024-09-26T14:26:55+02:00 info group runner description=3-green.shared-gitlab-org.runners-manager.gitlab.example.com/dind name=comp-test-ia paused=false runner=gitlab-runner tags=gitlab-org-docker type=instance_type
 2024-09-26T14:26:55+02:00 info group runner description=blue-3.saas-linux-large-amd64.runners-manager.gitlab.example.com/default name=comp-test-ia paused=false runner=gitlab-runner tags=saas-linux-large-amd64 type=instance_type
@@ -250,7 +250,7 @@ Pipeleek can generate a `.gitlab-ci.yml` or directly create a project and launch
 
 ```bash
 # Manual creation
-$ pipeleek gl runners --token glpat-[redacted] --gitlab https://gitlab.example.com -v exploit --tags saas-linux-small-amd64 --shell --dry
+$ pipeleek gl runners --token glpat-[redacted] --url https://gitlab.example.com -v exploit --tags saas-linux-small-amd64 --shell --dry
 2024-09-26T14:32:26+02:00 debug Verbose log output enabled
 2024-09-26T14:32:26+02:00 info Generated .gitlab-ci.yml
 2024-09-26T14:32:26+02:00 info ---
@@ -276,7 +276,7 @@ pipeleek-job-saas-linux-small-amd64:
 2024-09-26T14:32:26+02:00 info Done, Bye Bye 🏳️‍🌈🔥
 
 # Automated
-$ pipeleek gl runners --token glpat-[redacted]  --gitlab https://gitlab.example.com -v exploit --tags saas-linux-small-amd64 --shell
+$ pipeleek gl runners --token glpat-[redacted]  --url https://gitlab.example.com -v exploit --tags saas-linux-small-amd64 --shell
 2024-09-26T14:33:48+02:00 debug Verbose log output enabled
 2024-09-26T14:33:49+02:00 info Created project name=pipeleek-runner-exploit url=https://gitlab.example.com/[redacted]/pipeleek-runner-exploit
 2024-09-26T14:33:50+02:00 info Created .gitlab-ci.yml file=.gitlab-ci.yml

diff --git a/docs/guides/renovate.md b/docs/guides/renovate.md
@@ -174,7 +174,7 @@ Your goal is to abuse the Renovate bot's access level to merge a malicious `gitl
 Using Pipeleek, you can monitor your repository for new Renovate branches. When a new one is detected, Pipeleek tries to add a new job into the `gitlab-ci.yml`. As this needs to exploit a race condition (adding new changes to the Renovate branch before the bot activates auto-merge), this might take a few attempts.
 
 ```bash
-pipeleek gl renovate privesc -g https://gitlab.com -t glpat-[redacted] --repo-name company1/a-software-project --renovate-branches-regex 'renovate/.*' -v
+pipeleek gl renovate privesc -g https://gitlab.com -t glpat-[redacted] --project company1/a-software-project --renovate-branches-regex 'renovate/.*' -v
 2025-09-30T07:56:57Z debug Verbose log output enabled
 2025-09-30T07:56:57Z info Ensure the Renovate bot does have a greater access level than you, otherwise this will not work, and is able to auto merge into the protected main branch
 2025-09-30T07:56:58Z debug Testing push access level for default branch branch=main requiredAccessLevel=40 userAccessLevel=30

diff --git a/docs/guides/scanning.md b/docs/guides/scanning.md
@@ -34,5 +34,5 @@ As shown, Pipeleek can detect secrets in job logs and build artifacts. Security
 If you find a repository that looks particularly interesting e.g. `secret-pipelines`, you can scan all its job logs, not just the most recent ones:
 
 ```bash
-pipeleek gl scan -g https://gitlab.com -t glpat-[redacted] --cookie [redacted] --artifacts --repo mygroup/my-secret-pipelines-project
+pipeleek gl scan -g https://gitlab.com -t glpat-[redacted] --cookie [redacted] --artifacts --project mygroup/my-secret-pipelines-project
 ```
diff --git a/docs/introduction/configuration.md b/docs/introduction/configuration.md
@@ -13,7 +13,17 @@ Pipeleek can be configured via config files, environment variables, or CLI flags
 
 ## Quick Start
 
-Create `~/.config/pipeleek/pipeleek.yaml`:
+Generate a configuration template with all available options:
+
+```bash
+# Write to config file (recommended)
+pipeleek config gen --output ~/.config/pipeleek/pipeleek.yaml
+```
+
+
+The generated template documents all settings, their defaults, CLI flags, and environment variable names for quick reference.
+
+Then configure your needed object keys, for example:
 
 ```yaml
 gitlab:
@@ -32,7 +42,7 @@ pipeleek gl scan
 
 Configuration sources are resolved in this order (highest to lowest):
 
-1. **CLI flags** - `--gitlab`, `--token`, etc.
+1. **CLI flags** - `--url`, `--token`, etc.
 2. **Environment variables** - `PIPELEEK_GITLAB_TOKEN`
 3. **Config file** - `~/.config/pipeleek/pipeleek.yaml`
 4. **Defaults**
@@ -52,199 +62,7 @@ Config keys follow the pattern: `<platform>.<subcommand>.<flag_name>`
 
 Platform-level settings (like `url` and `token`) are inherited by all commands under that platform.
 
-### GitLab
-
-```yaml
-gitlab:
-  url: https://gitlab.example.com # Shared across all gl commands
-  token: glpat-xxxxxxxxxxxxxxxxxxxx # Shared across all gl commands
-  cookie: "" # Optional: _gitlab_session cookie for dotenv artifacts
-
-  enum:
-    level: full # gl enum --level
-
-  cicd:
-    yaml:
-      project: group/project # gl cicd yaml --project
-
-  schedule: {} # gl schedule (inherits url/token)
-
-  secureFiles: {} # gl secureFiles (inherits url/token)
-
-  variables: {} # gl variables (inherits url/token)
-
-  jobToken:
-    exploit:
-      project: group/project # gl jobToken exploit --project
-
-  vuln: {} # gl vuln (inherits url/token)
-
-  runners:
-    list: {} # gl runners list (inherits url/token)
-
-    exploit:
-      tags: [docker, linux] # gl runners exploit --tags
-      shell: bash # gl runners exploit --shell
-      dry: false # gl runners exploit --dry
-      age_public_key: "" # gl runners exploit --age-public-key
-      repo_name: "" # gl runners exploit --repo-name
-
-  renovate:
-    enum:
-      owned: true # gl renovate enum --owned
-      member: true # gl renovate enum --member
-      repo: false # gl renovate enum --repo
-      namespace: false # gl renovate enum --namespace
-      search: "" # gl renovate enum --search
-      fast: false # gl renovate enum --fast
-      dump: false # gl renovate enum --dump
-
-    bots:
-      term: renovate # gl renovate bots --term
-
-    autodiscovery: {} # gl renovate autodiscovery (inherits url/token)
-
-    privesc: {} # gl renovate privesc (inherits url/token)
-
-  register:
-    username: newuser # gluna register --username
-    password: secret # gluna register --password
-    email: user@example.com # gluna register --email
-
-  shodan:
-    json: shodan_data.json # gluna shodan --json
-
-  scan_public:
-    search: "" # gluna scan --search
-    repo: "" # gluna scan --repo
-    namespace: "" # gluna scan --namespace
-    job_limit: 0 # gluna scan --job-limit
-    queue: "" # gluna scan --queue
-    artifacts: false # gluna scan --artifacts
-
-  scan:
-    threads: 10 # gl scan --threads (can override common.threads)
-
-  snippets:
-    scan:
-      project: group/project # gl snippets scan --project
-      namespace: group # gl snippets scan --namespace
-      search: "" # gl snippets scan --search
-      owned: false # gl snippets scan --owned
-      member: false # gl snippets scan --member
-      # Runtime scan settings come from common.*:
-      # common.threads, common.trufflehog_verification,
-      # common.confidence_filter, common.hit_timeout (duration, e.g. "120s")
-
-  tf:
-    output_dir: ./terraform-states # gl tf --output-dir
-    threads: 4 # gl tf --threads (can override common.threads)
-    # Note: artifacts, max_artifact_size, and owned do not apply to gl tf.
-```
-
-### GitHub
-
-```yaml
-github:
-  url: https://api.github.com
-  token: ghp_xxxxxxxxxxxxxxxxxxxx
-
-  ghtoken:
-    exploit:
-      repo: owner/repo # gh ghtoken exploit --repo
-
-  scan:
-    owner: myorg
-    repo: myrepo
-```
-
-### BitBucket
-
-```yaml
-bitbucket:
-  url: https://bitbucket.org
-  email: user@example.com
-  token: ATATTxxxxxx
-
-  scan:
-    workspace: myworkspace
-    repo_slug: myrepo
-```
-
-### Azure DevOps
-
-```yaml
-azure_devops:
-  url: https://dev.azure.com/myorg
-  token: ado-token
-
-  scan:
-    project: myproject
-```
-
-### Gitea
-
-```yaml
-gitea:
-  url: https://gitea.example.com
-  token: gitea-token
-
-  enum:
-    owner: myorg # gitea enum --owner
-
-  secrets:
-    owner: myorg # gitea secrets --owner
-    repo: myrepo # gitea secrets --repo
-
-  variables:
-    owner: myorg # gitea variables --owner
-    repo: myrepo # gitea variables --repo
-
-  scan:
-    owner: myorg # gitea scan --owner
-    repo: myrepo # gitea scan --repo (optional, scans all if not specified)
-```
-
-### Jenkins
-
-```yaml
-jenkins:
-  url: https://jenkins.example.com
-  username: admin
-  token: jenkins-api-token
-
-  scan:
-    folder: team-a # jenkins scan --folder (optional)
-    job: team-a/service-a # jenkins scan --job (optional)
-    max_builds: 25 # jenkins scan --max-builds
-```
-
-### CircleCI
-
-```yaml
-circle:
-  url: https://circleci.com
-  token: circleci-token
-
-  scan:
-    project: [my-org/my-repo] # circle scan --project (optional if org is set)
-    vcs: github # circle scan --vcs
-    org: my-org # circle scan --org (also enables org-wide discovery when project is omitted)
-    # --org accepts: my-org, github/my-org, circleci/my-org (required for native
-    # CircleCI orgs), or app URL forms like
-    # https://app.circleci.com/pipelines/github/my-org/my-repo
-    # Note: org-wide discovery requires token visibility to that org. If not,
-    # use explicit --project selectors instead.
-    branch: main # circle scan --branch
-    status: [success, failed] # circle scan --status
-    workflow: [build, deploy] # circle scan --workflow
-    job: [unit-tests, release] # circle scan --job
-    since: 2026-01-01T00:00:00Z # circle scan --since (RFC3339)
-    until: 2026-01-31T23:59:59Z # circle scan --until (RFC3339)
-    max_pipelines: 0 # circle scan --max-pipelines (0 = no limit)
-    tests: true # circle scan --tests
-    insights: true # circle scan --insights
-```
+To view a full example of the available keys run `pipeleek config gen`.
 
 ### Common Settings
 
@@ -306,7 +124,7 @@ pipeleek gh scan --owned      # Uses GitHub config
 
 ```bash
 # Use config token but different URL
-pipeleek gl enum --gitlab https://gitlab-dev.company.com
+pipeleek gl enum --url https://gitlab-dev.company.com
 
 # Use config URL/token but different level
 pipeleek gl enum --level minimal
@@ -326,9 +144,51 @@ gitlab:
 pipeleek gl enum --token glpat-xxxxxxxxxxxxxxxxxxxx
 ```
 
+## Managing Config Values
+
+### Getting Config Values
+
+Read configuration values from your config file:
+
+```bash
+# Get a specific value
+pipeleek config get gitlab.token
+
+# Get an entire section (returns YAML)
+pipeleek config get gitlab
+
+# Get a nested value
+pipeleek config get gitlab.renovate.enum.fast
+
+# Get all configuration
+pipeleek config get
+```
+
+### Setting Config Values
+
+Write configuration values to your config file:
+
+```bash
+# Set a string value
+pipeleek config set gitlab.token "glpat-xxxxxxxxxxxxxxxxxxxx"
+
+# Set a number
+pipeleek config set common.threads 8
+
+# Set a boolean
+pipeleek config set common.truffle_hog_verification false
+
+# Set a list (YAML format)
+pipeleek config set gitlab.runners.exploit.tags '[\"docker\", \"shared\"]'
+```
+
 ## Full Example
 
-See [`pipeleek.example.yaml`](https://github.com/CompassSecurity/pipeleek/blob/main/pipeleek.example.yaml) for a complete example with all platforms and commands documented.
+See [`pipeleek.example.yaml`](https://github.com/CompassSecurity/pipeleek/blob/main/pipeleek.example.yaml) for a complete example with all platforms and commands documented or run:
+
+```bash
+pipeleek config gen
+```
 
 ## Troubleshooting
 

diff --git a/docs/introduction/getting_started.md b/docs/introduction/getting_started.md
@@ -132,7 +132,7 @@ Pipeleek also provides platform-specific binaries that include only the commands
 The most basic example to scan e.g. GitLab pipeline logs for secrets.
 
 ```bash
-pipeleek gl scan --token glpat-[redacted] --gitlab https://gitlab.example.com
+pipeleek gl scan --token glpat-[redacted] --url https://gitlab.example.com
 ```
 
 ### Scanning Artifacts
@@ -142,5 +142,5 @@ In addition to logs, Pipeleek can also scan artifacts generated by pipelines.
 > **💡Tip:** All `scan` commands must be configured to scan artifacts. This feature is disabled by default.
 
 ```bash
-pipeleek gl scan --token glpat-[redacted] --gitlab https://gitlab.example.com --artifacts
+pipeleek gl scan --token glpat-[redacted] --url https://gitlab.example.com --artifacts
 ```
diff --git a/docs/introduction/logging.md b/docs/introduction/logging.md
@@ -108,7 +108,7 @@ Setup a local ELK stack using https://github.com/deviantony/docker-elk.
 Then you can start a scan:
 
 ```bash
-pipeleek gl scan --token glpat-[redacted] --gitlab https://gitlab.example.com  --json | nc -q0 localhost 50000
+pipeleek gl scan --token glpat-[redacted] --url https://gitlab.example.com  --json | nc -q0 localhost 50000
 ```
 
 Using Kibana you can filter for interesting messages, based on the JSON attributes of the output.