dsh-grok-subscription-baroncyr

DSH Grok Subscription

简体中文 · English

Code, ask about images, and adjust reasoning in DSH with your Grok Build subscription.

Use a SuperGrok / X Premium Grok Build session to select models, attach images, and check weekly quota inside DeepSeek Harness. No separate pay-as-you-go xAI API key is required.

Features · Install · Daily use · Screenshots · User guide · Update and uninstall

Features

Install

You need DeepSeek Harness and a SuperGrok / X Premium account that currently has Grok Build access. The grok command is not required. The subscription name alone does not guarantee that access; the account's actual authorization determines it.

For DSH setup, see the official instructions. Version requirements are covered in Installation and compatibility.

1. Install the plugin

In the desktop app open Settings → Plugins, type the package name dsh-grok-subscription into the install field, and install it. Then quit and restart the desktop app completely: refreshing the page alone does not reload the Host adapter.

2. Sign in

Open Settings → Grok Subscription and select Sign in. The panel shows a link and a one-time code; after you authorize, the session is written to ~/.grok/auth.json. If this machine already has a session file, select Read saved session.

Sign-in and renewal run inside the plugin. It does not invoke the grok command. Do not paste XAI_API_KEY, and never share auth.json or tokens in chats, screenshots, or public issues.

3. Select a model

Pick a Grok model your account can use, adjust reasoning effort as needed, and start chatting or coding. The badge beside the model shows weekly quota when usage can be read successfully.

Settings → Plugins lists the installed plugins and their versions, and the plugin's own Settings → Grok Subscription page shows a version card. To pin a version, put the full package@version in the install field, for example dsh-grok-subscription@2.0.9.

If the UI install fails (an unusual profile directory, say), the equivalent runs against the desktop profile itself (pnpm ≥ 11):

cd "$HOME/.dsh/profiles/desktop"    # Windows: cd "$env:USERPROFILE\.dsh\profiles\desktop"
pnpm add --save-exact dsh-grok-subscription@2.0.9

dsh plugin --profile desktop … is refused: the Electron application owns that profile exclusively. Sign-in and troubleshooting are in the full user guide.

Daily use

Choose a model and effort. The catalog refreshes after sign-in. Use the effort levels shown for the selected model. A built-in fallback catalog does not grant additional model access.

Ask about images. Paste or attach an image while using a supported model. The current implementation advertises image input for grok-4.7, grok-4.7-build-fast, and grok-4.6, but not grok-4.5. This means reading images, not generating them. See Image input.

Check weekly quota. With the grok-build route selected, the badge shows the remaining percentage when the read succeeds; hover or click for the reset time. Settings has the full details. A failed quota read does not itself block chat.

Screenshots

Identity and time values in the account screenshot are demo data. Usage screenshots illustrate the UI, not a fixed allowance for any account.

User guide

The full user guide covers installation and compatibility, device-code sign-in, the model catalog, images, quota limitations, network troubleshooting, and development.

Quick links: Sign-in and credentials · Image input · Troubleshooting · Contributing.

Update and uninstall

Update: put dsh-grok-subscription (or dsh-grok-subscription@version) into the Settings → Plugins install field again to install over the current copy; the plugin's own page also has a version card and an Update plugin button. Then quit and restart the desktop app completely.

Update plugin keeps the release-age policy of DSH's bundled pnpm: by default it updates at once and pnpm records the version in the profile's minimumReleaseAgeExclude; under a stricter pnpm policy the button says when the update can run. When upgrading from 2.0.8 or earlier, install the exact version once in Settings → Plugins (for example dsh-grok-subscription@2.0.9) instead of clicking Update plugin in the old settings page: the old button skips the cooldown check, and for a version less than 24 hours old the profile then refuses other plugin installs for a while.

The desktop app owns its desktop profile exclusively, so dsh plugin --profile desktop … is refused there. The desktop Update plugin button therefore installs the exact version inside that profile directory with DSH's own bundled pnpm; before 1.1.1 that button always failed in the desktop app. Manual steps: Updates and sign-out.

Uninstall: remove dsh-grok-subscription in Settings → Plugins, or run pnpm remove dsh-grok-subscription in that profile directory, then restart the desktop app. Uninstalling leaves other plugins, the profile, and ~/.grok/auth.json intact, and does not revoke the xAI authorization; see Updates and sign-out.

Restart DSH afterwards. Removal does not delete other plugins, the whole profile, or ~/.grok/auth.json, and it does not revoke the xAI authorization. See Updates and sign-out.

FAQ

Empty model list? Sign in from Settings, or select Read saved session. An API-key-only entry is not a subscription login.

Sign-in or requests time out? Check connectivity from the DSH host to account and subscription services, including its launch-time proxy settings. Network issues, authentication, or service errors can cause failures; do not assume the quota is exhausted. See Troubleshooting.

A message fails with HTTP 426 and says the CLI is outdated? Update to the current release and restart completely. Settings and the model list can still look healthy, because only generation checks the client version. See Troubleshooting.

Images still unavailable after updating? Fully restart the desktop app, check the model's image support, and check that Active path in Settings reads official pi-ai with attachment capability available. An unavailable row means the host has no pi-ai adapter.

Scope and support

This is a community plugin, not affiliated with or endorsed by DeepSeek or xAI. Model access, reasoning options, and quota depend on the account and backend; the plugin does not grant extra entitlements.

The usage panel depends on an undocumented billing endpoint and is experimental. Upstream changes may make it unavailable. Keeping credentials out of browser responses does not mean offline inference: model requests still go to the Grok subscription service.

See SECURITY.md and use Issues for reports. Never publish login files, tokens, raw account responses, or complete login callbacks.

Local development

git clone https://github.com/BaronCyrus/dsh-grok-subscription.git
cd dsh-grok-subscription
npm ci
npm test
npm run build

lib/ contains committed build output. Rebuild it after changing src/ rather than editing it by hand. See CONTRIBUTING.md for development and verification requirements.

License

MIT