=============== LIBRARY RULES =============== From library maintainers: - Use README.md and docs/CONTEXT7.md for install, configuration, tool usage, security model, and runtime smoke tests. - Use docs/OBSERVABILITY.md for scripted Hermes runtime checks. - Use github.com/twexapi-dev/hermes-xapi#readme for end-to-end Hermes setup. - Use xapi_explore before xapi_read or xapi_action; xapi_action is disabled unless explicitly enabled. - Use pyproject.toml and the PyPI package hermes-xapi for package metadata and supported Python versions. - Do not ask users to pass credentials through tool arguments; use environment configuration. ### Install Plugin from Local Path Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/README.md Installs the plugin directly from a local directory path. ```bash hermes plugins install file:///absolute/path/to/hermes-xapi --force --enable ``` -------------------------------- ### Install Hermes XAPI Plugin Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/docs/CONTEXT7.md Commands to install and enable the plugin via the Hermes CLI. ```bash hermes plugins install twexapi-dev/hermes-xapi --enable ``` ```bash hermes plugins enable hermes-xapi hermes plugins list ``` -------------------------------- ### Install Hermes Plugin Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/README.md Installs and enables the Hermes plugin to provide agent runtime tools. ```bash hermes plugins install twexapi-dev/hermes-xapi --enable ``` -------------------------------- ### Install Hermes XAPI Plugin Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/registries/ask/hermes-xapi/SKILL.md Commands to install the plugin and verify the available tools in the Hermes environment. ```bash hermes plugins install twexapi-dev/hermes-xapi --enable hermes tools list ``` -------------------------------- ### Install Hermes XAPI Python Package Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/docs/CONTEXT7.md Install the package into the Hermes Python environment and enable the plugin. ```bash uv pip install --python ~/.hermes/hermes-agent/venv/bin/python hermes-xapi hermes plugins enable hermes-xapi ``` -------------------------------- ### Install Hermes XAPI Skill Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/README.md Adds the Hermes XAPI skill to the agent environment for discovery and telemetry. ```bash npx skills add twexapi-dev/hermes-xapi --skill hermes-xapi ``` -------------------------------- ### Verify Hermes XAPI Plugin Enablement Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/docs/MERGE_ENABLEMENT.md Use these commands to ensure plugins are correctly installed and enabled in documentation snippets. ```bash hermes plugins install twexapi-dev/hermes-xapi --enable ``` ```bash hermes plugins enable hermes-xapi ``` -------------------------------- ### Install Python Package via pip Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/README.md Installs the package into the Hermes Python environment using pip. ```bash ~/.hermes/hermes-agent/venv/bin/python -m pip install hermes-xapi hermes plugins enable hermes-xapi ``` -------------------------------- ### List Hermes plugins and tools Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/hermes_xapi/skills/hermes-xapi/references/endpoint-contract.md Verify the availability of plugins and tools within the Hermes runtime environment. ```bash hermes plugins list hermes tools list ``` -------------------------------- ### Configure Environment Variables Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/docs/CONTEXT7.md Set the required API key and optional configuration settings in the runtime environment. ```bash export TWEXAPI_KEY="twitterx_..." ``` ```bash export TWEXAPI_BASE_URL="https://api.twexapi.io" export HERMES_XAPI_ENABLE_ACTIONS="false" ``` -------------------------------- ### Configure Optional Settings Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/README.md Set optional environment variables for the API base URL and action enablement. ```bash export TWEXAPI_BASE_URL="https://api.twexapi.io" export HERMES_XAPI_ENABLE_ACTIONS="false" ``` -------------------------------- ### Enable Hermes XAPI Plugin Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/after-install.md Commands to enable the plugin and verify its status in the Hermes toolset. ```bash hermes plugins enable hermes-xapi hermes plugins list ``` -------------------------------- ### Configure API Key Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/README.md Set the required environment variable for TwexAPI authentication. ```bash export TWEXAPI_KEY="twitterx_..." ``` -------------------------------- ### Verify Skill Discovery Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/README.md Checks if the skills CLI can discover the repository before release. ```bash npx skills add twexapi-dev/hermes-xapi --skill hermes-xapi --list ``` -------------------------------- ### Run Development Checks Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/README.md Executes individual quality assurance and testing tools using uv with Python 3.12. ```bash uv run --python 3.12 --extra dev ruff format --check . uv run --python 3.12 --extra dev ruff check . uv run --python 3.12 --extra dev basedpyright uv run --python 3.12 --extra dev pytest --cov=hermes_xapi --cov=tests --cov-report=term-missing --cov-fail-under=100 uv run --python 3.12 --extra dev bandit -c pyproject.toml -r hermes_xapi scripts uv run --python 3.12 --extra dev pip-audit uv run --python 3.12 --extra dev python -m build uv run --python 3.12 --extra dev twine check dist/* ``` -------------------------------- ### Generate TwexAPI Catalog Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/README.md Executes the build script to generate a bundled catalog from the OpenAPI specification. ```bash python scripts/build_catalog.py ../twexapi/openapi.yaml ``` -------------------------------- ### Configure Action Permissions Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/after-install.md Disable account-changing operations by setting the environment variable. ```bash export HERMES_XAPI_ENABLE_ACTIONS=false ``` -------------------------------- ### Confirm Catalog Indexing Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/README.md Verifies that the skill has been indexed in the catalog. ```bash npx skills find hermes-xapi --owner twexapi-dev ``` -------------------------------- ### Run Local Quality Gate Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/README.md Executes the full suite of quality assurance checks sequentially as a single command chain. ```bash uv run --python 3.12 --extra dev ruff format --check . && \ uv run --python 3.12 --extra dev ruff check . && \ uv run --python 3.12 --extra dev basedpyright && \ uv run --python 3.12 --extra dev pytest --cov=hermes_xapi --cov=tests --cov-report=term-missing --cov-fail-under=100 && \ uv run --python 3.12 --extra dev bandit -c pyproject.toml -r hermes_xapi scripts && \ uv run --python 3.12 --extra dev pip-audit && \ uv run --python 3.12 --extra dev python -m build && \ uv run --python 3.12 --extra dev twine check dist/* ``` -------------------------------- ### Run Smoke Test Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/after-install.md Execute a test prompt to verify toolset functionality without triggering actions. ```bash hermes -z "Use xapi_explore, then read /twitter/elonmusk/about. Do not call xapi_action." --toolsets hermes-xapi ``` -------------------------------- ### Smoke Test Hermes XAPI Source: https://github.com/twexapi-dev/hermes-xapi/blob/master/docs/CONTEXT7.md Verify tool registration and functionality using the Hermes CLI. ```bash hermes tools list hermes -z "Use xapi_explore, then read /twitter/elonmusk/about. Do not call xapi_action." --toolsets hermes-xapi ```