中文

get is a compact command-line binary tool that calls a Large Language Model (LLM) via natural language to generate shell commands, then executes them on your device to retrieve any information you need.

get is open-sourced under the AGPL-3.0 license on GitHub.

Usage examples:

get "IP address of this device"
get "code structure in the current directory"
get "latest get version at https://github.com/Water-Run/get"

Installation

Download from GitHub Release. After extracting, run the bundled Python installation script get_ready.py to automatically complete installation and PATH configuration:

python get_ready.py

Follow the on-screen instructions. Once done, run get version to verify the installation.

After installation, run get_ready.py again to uninstall.

Prerequisites

Before use, you must configure at least the LLM-related parameters. get is compatible with the OpenAI API specification. Use the following commands to configure:

get set model your-model-name
get set url your-api-endpoint
get set key your-api-key

After configuration, run get isok to verify.

To clear a configuration value, leave the value empty. For example, to clear the key:

get set key

Quick Start

Usage is straightforward:

get "your question"

get is designed to perform read-only operations only. Every generated command goes through multiple layers of security validation before execution (built-in dangerous command regex blocking, plus optional double-check and manual confirmation).

set Options Reference

Integer options accept false to disable the feature entirely (equivalent to 0).

Examples of disabling integer options:

get set timeout false
get set cache-expiry false
get set log-max-entries false

command-pattern is matched against the command string before shell expansion. Blocking a literal filename can be bypassed by globbing (for example, cat *.txt), so reliable policies should target command verbs (cat, head, cp, etc.) instead.

Per-Query Overrides

The following flags can override persistent configuration for a single query, placed after the query string:

Examples:

get "disk usage" --no-cache
get "list files" --model gpt-5.3-codex --vivid

config Command

The config command is used to inspect the current configuration.

get config                # Show all current configuration
get config --reset        # Reset all configuration to defaults
get config --<option>     # Show the current value of a single option

--<option> accepts all option names from the set table above. get config --key shows whether a key is configured. The stored value is encrypted and cannot be retrieved. Disabled integer options display false.

get config --command-pattern   # View active pattern (full regex when default)
get set command-pattern        # Restore built-in default
get set command-pattern ""     # Disable pattern filtering

Command Reference

Cache

get uses a deferred-decision caching mechanism. Queries are not cached on first execution. Cache strategy classification is triggered only after a query has been seen at least cache-trigger-threshold times (default 1, which means classification on the second run), or when --cache is explicitly passed. During this decision step, get shows checking whether to cache... as progress text (when process output is not hidden). Five strategies are supported: GLOBAL_COMMAND (cache the command globally, re-execute on hit), GLOBAL_RESULT (cache the output globally, return directly), CONTEXT_COMMAND (cache the command for the current directory context, re-execute on hit), CONTEXT_RESULT (cache the output for the current directory context, return directly), or NOCACHE (do not cache).

Global entries work across any working directory; context entries are tied to the directory where the query was originally executed.

When hide-process is enabled, get suppresses its own intermediate progress and warning text (including cache checks and external-display checks), and only prints the final result or required errors.

When config cache is false, get emits a warning in normal process mode: warning: cache is disabled in config; all cache logic is bypassed.

get cache                       # Show cache status
get cache --clean               # Clear all cache entries and seen records
get cache --unset "system version"  # Remove cache entries matching the query
get set cache false             # Disable caching (disables all cache logic)

Log

get records each query execution to a local file. When the number of entries exceeds the log-max-entries limit, the oldest entries are automatically removed.

get log              # Show log status
get log --clean      # Clear all log entries
get set log false    # Disable logging

Miscellaneous

get get             # Show basic information about get (name, version, author, ...)
get get --intro     # Show introduction
get get --version   # Show version (equivalent to get version)
get get --license   # Show license identifier
get get --github    # Show GitHub link
get isok            # Verify that the current configuration is usable
get help            # Show usage help

File Storage & Exit Codes

File Storage Locations

• Config file: Linux ~/.config/get/config.json / Windows %APPDATA%/get/config.json
• API key: Linux ~/.config/get/key (permissions 0600) / Windows %APPDATA%/get/key (DPAPI encrypted)
• Execution log: Linux ~/.config/get/get.log / Windows %APPDATA%/get/get.log
• Response cache: Linux ~/.config/get/cache.json / Windows %APPDATA%/get/cache.json
• Built-in tools: <executable>/bin/ or <executable>/src/bin/

Exit Codes

• 0: Completed successfully
• 1: Configuration error, LLM communication failure, security check rejection, or general error
• 130: Interrupted by Ctrl+C (SIGINT)
• N: When a generated command exits with a non-zero code, that exit code is passed through as get's exit code