Skip to content

docs: migrate OpenCode names to MiMoCode in config and CLI docs#1155

Open
itxaiohanglover wants to merge 2 commits into
XiaomiMiMo:mainfrom
itxaiohanglover:fix/docs-opencode-to-mimocode
Open

docs: migrate OpenCode names to MiMoCode in config and CLI docs#1155
itxaiohanglover wants to merge 2 commits into
XiaomiMiMo:mainfrom
itxaiohanglover:fix/docs-opencode-to-mimocode

Conversation

@itxaiohanglover

Copy link
Copy Markdown

Fixes #1150

Why

The config and CLI docs (config.mdx, cli.mdx) were carried over from the OpenCode fork and never migrated to MiMoCode names. They instruct users to set OPENCODE_* env vars, create .opencode directories, and reference opencode.ai schema URLs that the current code does not honor — a user following these docs is silently ignored.

What changed

  • OPENCODE_CONFIGMIMOCODE_CONFIG
  • OPENCODE_CONFIG_CONTENTMIMOCODE_CONFIG_CONTENT
  • OPENCODE_CONFIG_DIRMIMOCODE_CONFIG_DIR
  • .opencode directories → .mimocode
  • ~/.config/opencode/~/.config/mimocode/
  • opencode.ai/config.jsonmimocode.ai/config.json
  • CLI command opencodemimo (actual binary name per package.json bin)
  • /etc/opencode//etc/mimocode/
  • All "OpenCode" prose references → "MiMoCode"

Verification

Verified actual env var names against source code:

  • packages/opencode/src/flag/flag.ts defines MIMOCODE_CONFIG, MIMOCODE_CONFIG_CONTENT, MIMOCODE_CONFIG_DIR
  • packages/opencode/src/config/paths.ts uses .mimocode directories
  • packages/opencode/package.json bin is mimo (not opencode)

No opencode references remain except the plugin package name opencode-helicone-session (an actual package name).

Adjacent issues (not in this PR)

  • shared/global.ts may also contain OpenCode references — not checked in this PR.
  • The opencode package directory name (packages/opencode/) is internal and not changed.

Replace OPENCODE_* env vars with MIMOCODE_*, .opencode directories
with .mimocode, opencode.ai schema URLs with mimocode.ai, and
~/.config/opencode paths with ~/.config/mimocode.

Verified against source: flag/flag.ts defines MIMOCODE_CONFIG,
MIMOCODE_CONFIG_CONTENT, MIMOCODE_CONFIG_DIR; paths.ts uses .mimocode.
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.

docs: config.mdx / cli.mdx still document OpenCode names (OPENCODE_* env vars, .opencode paths, opencode.ai $schema) that MiMoCode does not honor

1 participant