Docs / Codex Skill
Share a Codex conversation as a public preview page
Install the optional share-codex-chat skill for Codex, export the visible chat transcript as a high-fidelity HTML page, and deploy it to PreviewShip as a public URL.
Updated 2026-06-05
Answer First
The share-codex-chat skill is a companion workflow for Codex users. After installation, reference `$share-codex-chat` in Codex to turn the visible conversation into a self-contained HTML page, deploy it with PreviewShip, and get a shareable URL for debugging context, implementation records, or review discussions.
Key takeaways
- This is an optional Codex workflow, not a requirement for normal PreviewShip deploys.
- Global install uses `-g`; project-local install omits `-g` and should be run from the project root.
- The generated page aims to preserve visible Codex UI: user bubbles, assistant replies, uploaded image thumbnails, plugin mentions, processing rows, file cards, and change summaries.
- The skill is designed to filter hidden system/developer context, tool logs, API keys, and secrets before sharing.
Recommended workflow
- Install globally with `npx skills add blockdancez/PreviewShip --skill share-codex-chat -a codex -g --yes`, or install locally from a project root without `-g`.
- Make sure PreviewShip CLI is authenticated with `npx previewship login`, or set `PREVIEWSHIP_API_KEY` for the environment.
- In Codex, run `$share-codex-chat 分享当前 Codex 对话`.
- Review the generated HTML page and share the PreviewShip URL returned by the skill.
Comparison snapshot
| Question | share-codex-chat skill | Normal PreviewShip deploy |
|---|---|---|
| Primary input | Visible Codex chat transcript | HTML, Markdown, or static build output |
| Best for | Sharing implementation context | Sharing frontend artifacts |
| Install path | npx skills add blockdancez/PreviewShip | npx previewship or MCP/editor extension |
| Required for deploys? | No, optional for Codex users | Yes, core PreviewShip workflow |
When to use the Codex chat sharing skill
Use this skill when the conversation itself is the artifact you want to share: a debugging trail, a code-review discussion, a step-by-step implementation record, or a handoff between people.
It is different from deploying a frontend build. PreviewShip still handles the final public URL, but the skill first reconstructs the visible Codex chat as an HTML page.
- Global install: `npx skills add blockdancez/PreviewShip --skill share-codex-chat -a codex -g --yes`.
- Project-local install: `npx skills add blockdancez/PreviewShip --skill share-codex-chat -a codex --yes`.
- Codex usage: `$share-codex-chat 分享当前 Codex 对话`.
Privacy and review expectations
The skill is designed to export visible chat content and avoid hidden system/developer context, tool traces, API keys, and secrets.
Even so, treat the generated page like any public preview: review it before sharing if the conversation includes customer names, private repo paths, screenshots, or sensitive implementation details.
FAQ
- Is share-codex-chat part of the main PreviewShip deploy flow?
- No. It is an optional Codex skill for sharing conversations. Normal PreviewShip usage still focuses on HTML, Markdown, and static build artifacts.
- What is the difference between global and local install?
- The `-g` flag installs the skill globally for the user. Omitting `-g` installs it into the current project, usually under `.agents/skills/share-codex-chat`.
- Does the skill require a PreviewShip API key?
- Yes for deployment. If the CLI is not authenticated, run `npx previewship login` or configure `PREVIEWSHIP_API_KEY` before sharing.
- Can it perfectly export every Codex message?
- It aims to reproduce visible chat UI and known Codex message types. If earlier context is compacted or image files are unavailable, the exported page may note that limitation.