Skip to content

[good first issue-platform adapt-Ellama] Add Memory adapter for Ellama (Emacs) - #1159

Open
LeonSGP43 wants to merge 1 commit into
TencentCloud:feat/server_teamfrom
LeonSGP43:feat/ellama-adapter
Open

[good first issue-platform adapt-Ellama] Add Memory adapter for Ellama (Emacs)#1159
LeonSGP43 wants to merge 1 commit into
TencentCloud:feat/server_teamfrom
LeonSGP43:feat/ellama-adapter

Conversation

@LeonSGP43

Copy link
Copy Markdown

Summary

Adds a docs-only adapter for Ellama (s-kostyaev/ellama, the Emacs LLM assistant), connecting it to the TencentDB Agent Memory proxy through the llm package's built-in OpenAI-compatible provider — the same editor-adapter line as the gptel adapter.

  • adapters/ellama/README.md + README_CN.md (EN/CN, same structure as the gptel docs-only adapter)
  • No code changes: the provider lives in the user's own Emacs config.

How it connects (verified against official sources)

  • Ellama's README states the same commands can be configured for OpenAI-compatible APIs, and ellama-select-model lists "OpenAI-compatible" as a built-in provider choice with URL editing.
  • The llm package docs (§3.2) define make-llm-openai-compatible with :url — the base URL leading up to the command (chat/completions), e.g. https://api.openai.com/v1/ with trailing slash — plus :chat-model / :embedding-model.
  • The :key slot was verified in the llm-openai.el source: llm-openai-compatible includes llm-openai, so the key is accepted and sent as Authorization: Bearer (key checking is a no-op for compatible providers since some don't require one — ours does).
  • Pointing :url at http://127.0.0.1:8096/codebuddy/<spaceId>/v1/ lands on the proxy's canonical route.

Contents

  • Prerequisites (one-command stack, business sk-mem-... user key)
  • Setup: export key → configure ellama-provider → align model with PROXY_UPSTREAM_MODEL → verify via M-x ellama-chat and the session picker
  • Configuration reference table + troubleshooting table (URL-shape/auth/model-id/session-picker/GUI-env rows)
  • Notes: docs-only rationale, interactive ellama-select-model route, auth-source alternative for the key, data-flow statement

Part of the platform-adapt batch tracked in #926.

…m package)

Docs-only adapter connecting s-kostyaev/ellama (Emacs LLM assistant) to
the memory proxy through the llm package's built-in OpenAI-compatible
provider: :url is the trailing-slash base (/codebuddy/<spaceId>/v1/),
llm appends chat/completions; :key (inherited from llm-openai) sends the
sk-mem-... business user key as Bearer. EN/CN README with setup,
configuration reference, troubleshooting, and an auth-source
alternative, following the gptel adapter format.

Signed-off-by: LeonSGP43 <cine.dreamer.one@gmail.com>
@Maxwell-Code07

Copy link
Copy Markdown
Collaborator

Thank you so much for your attention and contribution! We will arrange an internal review for this PR shortly, and all feedback will be shared right here in the discussion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants