Skip to main content

Open Research Intelligence for the terminal

Project description

EVIDION

Tests License: MIT

Open Research Intelligence for the terminal.

Evidion turns a question into a transparent research process. It starts by showing you a research plan. You can approve it, add constraints, or cancel. Only after approval does it search and write a source-linked report.

Evidion is free and open source under the MIT License.

What it does today

  1. Understands a question and proposes a plan before searching.
  2. Searches a SearXNG instance that you control.
  3. Safely reads public HTML sources; local/private network destinations, unsafe redirects, and non-HTML responses are blocked.
  4. Saves sources, extracted source statements, possible conflicts, research gaps, and the confirmed plan in a resumable session.
  5. Exports Markdown, text, HTML, and JSON reports.
  6. Uses local or API-backed model providers for structured plan generation.

The evidence checks are deliberately conservative. A source-reported claim is not an independently verified fact, and a possible conflict is a signal to inspect—not an automatic verdict.

Install

Evidion supports Python 3.8 or newer on macOS, Windows, and Linux. A current Python release is recommended, but the lower baseline keeps Evidion usable on more existing computers.

From PyPI

Once the first PyPI publication is complete:

python3 -m pip install --user evidion

From GitHub now

The released source can already be installed directly:

python3 -m pip install --user "git+https://github.com/EvidionAI/evidion.git@v1.0.0"

After either installation, start Evidion from any directory:

evidion

If the command is not found, add Python's user scripts directory to your shell PATH. Typical locations are:

# macOS (replace 3.9 with your Python minor version)
export PATH="$HOME/Library/Python/3.9/bin:$PATH"

# Linux
export PATH="$HOME/.local/bin:$PATH"

# Windows PowerShell
$env:Path += ";$env:APPDATA\\Python\\Python38\\Scripts"

For development:

git clone https://github.com/EvidionAI/evidion.git
cd evidion
python3 -m pip install -e .

Quick start

Web research needs a SearXNG instance with JSON output. If you run one locally, configure it once:

evidion config set --searxng-url http://localhost:8080

Then ask a question:

evidion research "Are local AI models useful for small companies?" --mode normal

Evidion displays the plan first. Press Enter to approve, write add to include constraints such as “focus on Switzerland”, or write cancel to stop before any web search happens.

Commands at a glance

Command What it does
evidion Opens an interactive prompt for several questions in one session.
evidion plan "QUESTION" Shows a plan only; it never searches the web.
evidion research "QUESTION" Shows a plan, waits for approval, researches, and writes reports.
--mode fast Uses the smallest bounded search pass for a quick overview.
--mode normal Uses a broader, multi-round search and follows up on basic coverage gaps.
--mode deep Raises limits; fully dynamic deep research is planned for a later release.
--max-pages N Caps the number of pages Evidion may read.
--export all Writes Markdown, text, HTML, and JSON reports.
--output PATH Stores reports and session data in a chosen directory.
evidion sessions Lists saved research sessions.
evidion resume latest Continues the latest incomplete session.
evidion config show Shows the active model, storage, and search configuration.

See the command guide for complete examples.

Model providers and API keys

Evidion supports local Ollama and LM Studio, plus OpenAI, Anthropic, Google Gemini, OpenRouter and several OpenAI-compatible APIs. API keys are stored in the operating system credential store, not in the configuration file: macOS Keychain, Windows Credential Manager, or the configured Linux credential backend. To ensure a key is never saved, select environment-only mode.

evidion providers
evidion keys set openrouter
evidion models openrouter --free
evidion doctor
evidion config set --key-storage environment

Read the provider guide before adding a provider key.

Where files are stored

By default Evidion stores data under ~/Documents/Evidion/:

~/Documents/Evidion/
├── Reports/     # Markdown, text, HTML, and JSON exports
└── Sessions/    # Resumable research state

Set EVIDION_HOME to choose another data directory, or EVIDION_CONFIG to use a different configuration file. The default configuration file is platform-native:

  • macOS: ~/Library/Application Support/Evidion/config.json
  • Windows: %APPDATA%\\Evidion\\config.json
  • Linux: $XDG_CONFIG_HOME/evidion/config.json (or ~/.config/evidion/config.json)

Privacy and safety

  • Search queries go only to the configured SearXNG instance.
  • Web content is treated as untrusted data, never as instructions.
  • The reader refuses local/private addresses, unsafe redirects, unsupported protocols, and non-HTML content.
  • No API keys are included in web-research prompts.

See SECURITY.md and docs/security.md.

Publishing to PyPI

The distribution name is evidion. The official PyPI API returned 404 for that name on 24 July 2026, so it appears available now; a name is only claimed by a successful first upload. The project is prepared for passwordless Trusted Publishing from GitHub Actions. Follow the PyPI guide to make pip install evidion available.

Contributing

Issues and pull requests are welcome. Please read CONTRIBUTING.md, the Code of Conduct, and the architecture overview.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

evidion-3.0.0.tar.gz (41.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

evidion-3.0.0-py3-none-any.whl (37.3 kB view details)

Uploaded Python 3

File details

Details for the file evidion-3.0.0.tar.gz.

File metadata

  • Download URL: evidion-3.0.0.tar.gz
  • Upload date:
  • Size: 41.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for evidion-3.0.0.tar.gz
Algorithm Hash digest
SHA256 d3be26fe5ef5b92f1c242a0b4aa8db0911a95c08077270869a717b1b7658b826
MD5 d7119365232466b38d4b7a0d4b2b48b1
BLAKE2b-256 166213b0bba9cec4360ad20f6fb589a0d0fc15771620cf0ab750162cf09a1c66

See more details on using hashes here.

Provenance

The following attestation bundles were made for evidion-3.0.0.tar.gz:

Publisher: publish.yml on EvidionAI/evidion

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file evidion-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: evidion-3.0.0-py3-none-any.whl
  • Upload date:
  • Size: 37.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for evidion-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 08a73dc340c3784ee7671862b0002a20d141e9754734caf2f2ebb99c0d96ff66
MD5 9c1b4d9188e05badeb78a3222b390a59
BLAKE2b-256 63ee5e7705622adcfc0664a54d933caa23ad82dbf8a6b4bec95b373b6bc477c6

See more details on using hashes here.

Provenance

The following attestation bundles were made for evidion-3.0.0-py3-none-any.whl:

Publisher: publish.yml on EvidionAI/evidion

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page