Skip to content

Rename cliproxiapi to correctly spelled cliproxyapi #3

Description

@RaviTharuma

Problem

The repository and published npm package spell CLIProxyAPI as cliproxiapi:

opencode-cliproxiapi-auth
               ^

The expected spelling is:

opencode-cliproxyapi-auth
               ^

Current locations affected include:

  • repository: GRomR1/opencode-cliproxiapi-auth
  • npm package: opencode-cliproxiapi-auth
  • package metadata, README installation examples, import specifiers, cache/vendor paths, and discovery keywords

The correctly spelled npm package name is currently unregistered (npm view opencode-cliproxyapi-auth returns 404), so there is still an opportunity to correct this before the existing name gains wider adoption.

Impact

  • Users naturally search for cliproxyapi, not cliproxiapi.
  • The typo makes the package and repository harder to discover.
  • It is easy to mistype installation/configuration instructions.
  • It creates inconsistent naming alongside the upstream project CLIProxyAPI.
  • Correcting it later becomes increasingly disruptive as more configs depend on the old package name.

Suggested migration

  1. Publish the package under the correctly spelled name:

    opencode-cliproxyapi-auth
    
  2. Rename the GitHub repository to match. GitHub will preserve redirects from the former URL.

  3. Publish one final version under the misspelled npm name that:

    • is marked deprecated with npm deprecate,
    • points users to the corrected package,
    • contains clear migration instructions.
  4. Update README examples, package metadata, CI publishing configuration, badges, and repository URLs.

  5. Keep the provider ID cliproxyapi unchanged so stored OpenCode credentials and model references do not require migration.

  6. Document that OpenCode users only need to replace the plugin package specifier; their auth.json provider entry can remain intact.

Because npm package names cannot be renamed in place, a staged package migration is safer than silently abandoning the existing name.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions