Skip to content

docs(build-agent): host-first credential flow with the settings deep link#16

Open
mmabrouk wants to merge 1 commit into
mainfrom
fix/build-agent-credential-flow
Open

docs(build-agent): host-first credential flow with the settings deep link#16
mmabrouk wants to merge 1 commit into
mainfrom
fix/build-agent-credential-flow

Conversation

@mmabrouk

@mmabrouk mmabrouk commented Jul 7, 2026

Copy link
Copy Markdown
Member

Context

The build-agent first-run flow asked for the API key before knowing which Agenta the user is on, and only mentioned cloud.agenta.ai. Users on the EU or US cloud (or self-hosting) got a link that does not open their instance, and had to find the API keys page by hand.

Changes

The credentials step in skills/build-agent/SKILL.md now resolves the host first, then links straight to the key:

  1. Check AGENTA_API_KEY / AGENTA_HOST in the environment and .env; never re-ask for a value that is already set.
  2. One question: EU cloud, US cloud, or self-hosting. EU → https://eu.cloud.agenta.ai, US → https://us.cloud.agenta.ai, self-hosting → ask for the URL. Unsure → the default https://cloud.agenta.ai.
  3. Ask for the API key with a direct link to <host>/settings?tab=apiKeys, which opens the API keys page in the user's own workspace (with a sidebar fallback for older self-hosted versions that 404 on the bare path).

The README credentials section says the same thing. Storage rules (write a .env or hand over an export block, never print or commit the key) are unchanged.

Scope / risk

Docs-only: SKILL.md and README. No script changes; lib.sh already defaults AGENTA_HOST to https://cloud.agenta.ai and picks up .env.

The <host>/settings?tab=apiKeys deep link ships with Agenta-AI/agenta#5141; the skill includes the sidebar fallback for instances that predate it.

https://claude.ai/code/session_01DjaJLpnLtnoRhgbYe7NTC3

…link

Resolve the host before asking for the API key: check the environment, then
ask EU cloud / US cloud / self-hosting, then link the user straight to
<host>/settings?tab=apiKeys to copy the key.

Claude-Session: https://claude.ai/code/session_01DjaJLpnLtnoRhgbYe7NTC3
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.

1 participant