Skip to content

docs(readme): add Console start to Quick Start - #173

Merged
oleg-bk merged 1 commit into
mainfrom
codex/console-readme-discoverability-v1
Oct 14, 2026
Merged

oleg-bk merged 1 commit into
mainfrom
codex/console-readme-discoverability-v1

Conversation

@oleg-bk

@oleg-bk oleg-bk commented Oct 14, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Adds a Start from the Console subsection as the first item in Quick Start: sign in, pick an agent, run the command the Console shows; setup opens the Console to approve the machine; login / logout for headless or skipped connects.
  • Adds a Console link to the top navigation and to the Packages / Website line.

Additive only: no existing README text removed or reworded. Docs only: no code or package change, no PyPI release.

Verification

  • git diff --check: clean
  • tests/test_mcp_packaging.py (reads README.md): 21 passed
  • Pre-commit claim check: no unguarded strong claim phrases

Root README never mentioned the hosted Console. Additive only: a Console link
in the top navigation and in the Packages/Website line, and a new first
Quick Start subsection that explains starting from the Console, that setup
opens the Console to approve the machine, and login/logout for headless or
skipped connects. No existing text removed or reworded; no code or package
change.
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-14T07:15:01.738046Z 229dd10 PR opened
🔒 Security Review ✅ Completed 2026-10-14T07:16:04.192048Z 229dd10 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 229dd10185

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
Comment on lines +100 to +101
`login` prints a verification URL and a short code (`--no-open` for headless
use); `agentveil-mcp-proxy logout` disconnects this machine. See

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Bypass browser-session attach for --no-open

For a headless user following this recommendation, login --no-open does not initially print a usable URL or code. run_console_login_cli first invokes _acquire_console_credential_via_attach, which suppresses opening start.attach_url but still blocks in poll_for_token; pairing—and the documented verification URL/code—is attempted only after attach fails or expires. Since attach responses may specify up to a 3600-second lifetime, the advertised headless flow can appear hung for up to an hour. Either make --no-open skip attach and start device pairing immediately, or do not recommend it as the headless path.

Useful? React with 👍 / 👎.

@oleg-bk
oleg-bk merged commit b671912 into main Oct 14, 2026
16 checks passed
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