Skip to content
Back to search

abstract-search-export

Search, check and export events from an Abstract Security tenant: browser app, guided terminal, command line and MCP server. Docker, single file or Python.

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/iamabs3c--abstract-search-export/badge.svg)](/listings/iamabs3c--abstract-search-export)

HTML

<a href="/listings/iamabs3c--abstract-search-export"><img src="/api/listings/iamabs3c--abstract-search-export/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 154 lines
  1. # Abstract Search & Export
  2. Find the events you want in your Abstract Security tenant and export every one of them, with proof that the export is complete. It is a companion to Abstract for jobs that are too large, too repetitive or too scripted for the search screen: long ranges that reach into the archive, exports that run on a schedule, and searches driven by a script or an AI assistant.
  3. It is one engine with four ways in: a browser app, a guided terminal, a command line and an MCP server. It uses Python's standard library and nothing else, so there is nothing to install beyond the tool itself.
  4. ![The browser app: a search, previewed](search-export/docs/screenshots/web-03-preview.png)
  5. ## Start it
  6. Pick the one that fits. Every route ends at the same app.
  7. | You have | Do this | Details |
  8. |---|---|---|
  9. | **Docker** | `docker run --rm -p 127.0.0.1:8765:8765 -v "$HOME/AbstractExports:/exports" iamabs3c/abstract-search-export` and open the link it prints | [Docker](#docker) |
  10. | **Nothing installed** | Download the single file for your system from [Releases](../../releases/latest) and run it | [A single file](#a-single-file) |
  11. | **Python 3.8 or newer** | `python3 search-export/abstract_search.py --web` | [Python](#python) |
  12. | **A browser and a GitHub account** | [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/IamABS3C/abstract-search-export?quickstart=1) | [Codespaces and DevPod](docs/codespaces-and-devpod.md) |
  13. | **DevPod** | [![Open in DevPod](https://devpod.sh/assets/open-in-devpod.svg)](https://devpod.sh/open#https://github.com/IamABS3C/abstract-search-export) | [Codespaces and DevPod](docs/codespaces-and-devpod.md) |
  14. | **Claude Code** | Open this repository in a session: the tool and its MCP server are set up by the repository | [Claude environments](docs/claude-environments.md) |
  15. | **Another AI assistant** | Point it at the MCP server: `python3 search-export/abstract_search.py mcp` or the image with `mcp` | [MCP](search-export/docs/MCP.md) |
  16. ## Connect your tenant
  17. You need two things from Abstract: your **vendor account ID** and an **API key**.
  18. 1. Start the app by any route above and open the link it prints.
  19. 2. In **Connect to your tenant**, enter the vendor account ID and the API key, and choose **Connect**.
  20. 3. The app shows the tenant's name. Check it is the one you meant.
  21. The key is held in the app's memory while it runs. It is never written to disk, to a log, to an export or to the browser's storage, and it is never sent back to the page.
  22. For the command line, scheduled jobs and assistants, give the credentials through the environment instead:
  23. | Variable | Value |
  24. |---|---|
  25. | `ABSTRACT_VENDOR_ACCOUNT_ID` | Your vendor account ID. |
  26. | `ABSTRACT_EXPECT_TENANT` | The same ID. Every command refuses to run when the key belongs to another tenant. |
  27. | `ABSTRACT_API_KEY_COMMAND` | A command that prints the key from your secret manager or keychain, for example `op read "op://Security/Abstract API/credential"`. Recommended. |
  28. | `ABSTRACT_API_KEY_FILE` | Or a file that holds the key on one line, where secrets are mounted as files. |
  29. | `ABSTRACT_API_KEY` | Or the key itself, where a scheduler or CI system injects secrets. |
  30. Then check the connection. This reads only, and names the tenant:
  31. ```
  32. python3 search-export/abstract_search.py capabilities
  33. ```
  34. ## Docker
  35. The image holds Python and the tool. It runs as an unprivileged user and downloads nothing when it starts.
  36. ```
  37. docker run --rm -p 127.0.0.1:8765:8765 -v "$HOME/AbstractExports:/exports" iamabs3c/abstract-search-export
  38. ```
  39. - Open the link in the output. In Docker Desktop, it is in the container's **Logs** tab.
  40. - Exports are written to `AbstractExports` in your home folder.
  41. - The port is published to this computer only. Keep it that way.
  42. Or let the start script do it. It starts the app in the background, prints the link and opens your browser:
  43. ```
  44. curl -fsSLO https://raw.githubusercontent.com/IamABS3C/abstract-search-export/main/search-export/run-docker.sh
  45. sh run-docker.sh # start sh run-docker.sh link a new link
  46. sh run-docker.sh stop # stop sh run-docker.sh terminal the guided terminal
  47. ```
  48. On Windows, in PowerShell:
  49. ```
  50. irm https://raw.githubusercontent.com/IamABS3C/abstract-search-export/main/search-export/run-docker.ps1 -OutFile run-docker.ps1
  51. powershell -ExecutionPolicy Bypass -File .\run-docker.ps1
  52. ```
  53. From a checkout of this repository, `./run.sh` (or `.\run.ps1`) builds the image from the source here instead of pulling it.
  54. The same image runs single commands and the MCP server:
  55. ```
  56. docker run --rm -e ABSTRACT_VENDOR_ACCOUNT_ID -e ABSTRACT_EXPECT_TENANT -e ABSTRACT_API_KEY \
  57. -v "$HOME/AbstractExports:/exports" iamabs3c/abstract-search-export export --dataset "Okta" --last 24h --merge
  58. ```
  59. Compose, another port, secret files, scheduled exports and how the container is locked down: [Run it in Docker](search-export/docs/DOCKER.md).
  60. | Image | Where |
  61. |---|---|
  62. | `iamabs3c/abstract-search-export` | [Docker Hub](https://hub.docker.com/r/iamabs3c/abstract-search-export). |
  63. | `ghcr.io/iamabs3c/abstract-search-export` | GitHub's container registry. The same image. |
  64. Both carry the version (`0.5.0`), the minor line (`0.5`) and `latest`, for Intel and Arm.
  65. ## A single file
  66. Each [release](../../releases/latest) carries one file per system. It needs no Python and no Docker.
  67. | System | File |
  68. |---|---|
  69. | Windows (Intel) | `abstract-search-<version>-windows-x64.exe` |
  70. | macOS (Apple silicon) | `abstract-search-<version>-macos-arm64` |
  71. | Linux (Intel) | `abstract-search-<version>-linux-x64` |
  72. | Linux (Arm) | `abstract-search-<version>-linux-arm64` |
  73. Run it with no arguments for the guided terminal, or with `--web` for the browser app. Checking the download, the first-run prompts on macOS and Windows, and building it yourself: [The single-file program](docs/binaries.md).
  74. ## Python
  75. Python 3.8 or newer, on macOS, Linux or Windows. Nothing to install.
  76. ```
  77. git clone https://github.com/IamABS3C/abstract-search-export.git
  78. cd abstract-search-export
  79. python3 search-export/abstract_search.py --web # the browser app
  80. python3 search-export/abstract_search.py # the guided terminal
  81. python3 search-export/abstract_search.py --help # the command line
  82. ```
  83. On Windows, use `py` in place of `python3`.
  84. ## What it does
  85. - **Search any way you think.** Build a search with filters and every operator Abstract offers, write KQL, describe it in plain English and let Abstract's assistant write the query, or start from a saved view. Every search is checked against your tenant before it runs.
  86. - **Export everything, and prove it.** Recent data and the archive, in slices that resume where they stopped. The export is reconciled against the platform's own count, and the result says complete, partial or incomplete in plain words.
  87. - **Change saved views and fieldsets, safely.** Build a fieldset from the fields a dataset really fills, save a search as a view, or keep both as files and copy them between tenants. Every change is shown for review first and logged.
  88. - **Run on a schedule.** The tool writes a ready job for cron, launchd, systemd, Windows Task Scheduler, GitHub Actions or a container platform.
  89. - **Work from an assistant.** The MCP server gives an AI assistant the same steps, read-only unless you allow changes.
  90. The full guide, with every screen: [search-export/README.md](search-export/README.md). In the app, choose **Help**.
  91. ## Security in one page
  92. - The key is held in memory only and sent only to the Abstract API, over HTTPS. The tool never follows a redirect.
  93. - The browser app listens on this computer only, needs a one-time link to sign in, and loads nothing from the internet.
  94. - The only things it changes in a tenant are saved views and fieldsets, each after a review you confirm.
  95. - Exports are real data. They stay in your exports folder until you delete them.
  96. - Release files and images carry a build record you can check: `gh attestation verify <file> --repo IamABS3C/abstract-search-export`.
  97. Everything it calls, stores and sends: [Security](search-export/docs/SECURITY.md).
  98. ## In this repository
  99. | Path | What it is |
  100. |---|---|
  101. | `search-export/` | The tool: the program, its tests, its docs and the container build. |
  102. | `run.sh`, `run.ps1` | Start it in Docker from a checkout. |
  103. | `.devcontainer/` | The dev container for Codespaces, DevPod and VS Code. |
  104. | `.mcp.json`, `.vscode/mcp.json` | The MCP server, set up for Claude Code and for VS Code. |
  105. | `.claude/`, `CLAUDE.md` | What a Claude Code session needs to use the tool well. |
  106. | `deploy/claude-self-hosted/` | A runner image for a self-hosted Claude environment. |
  107. | `scripts/` | The session and welcome scripts, and the single-file build. |
  108. | `.github/workflows/` | Tests on every push; images, files and a release on every version tag. |
  109. Tests need no network and no key: `cd search-export/tests && python3 -m unittest discover -q`.

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.