Authentication Docs Confusing

Open
#110 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
52/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
authentication, cli, documentation

Research direction

Start with the CLI authentication documentation, especially the file-based storage text and the linked “Token not found” section. Compare those examples and commands with the reported ~/.sprites/sprites.json output and authentication commands; done means the documentation matches the current file format and gives a valid way to find token information.

Written by the indexing model from the issue text.

Description

Docs say:

When using file-based storage, ~/.sprites/sprites.json contains:

But when I look at mine after disabling keyring it doesn't look like that at all.

(✓) 15:34 [~/gravity/mgmt]
$ sprite org keyring disable

--- Org selector
Keyring usage is already disabled.

(✓) 15:35 [~/gravity/mgmt]
$ cat ~/.sprites/sprites.json
{
  "version": "1",
  "current_selection": {
    "url": "https://api.sprites.dev",
    "org": "patrick-kilgore"
  },
  "urls": {},
  "disable_keyring": true,
  "last_version_check": "2026-01-24T13:53:49-06:00",
  "latest_version": "v0.0.1-rc30",
  "users": [
    {
      "id": "974DxVGmwaGRJHOlQ",
      "email": "[SNIP]",
      "config_path": "[SNIP]",
      "token_path": "[SNIP]"
    }
  ],
  "current_user": "974DxVGmwaGRJHOlQ",
  "path_history": {
    "[SNIP]": {
      "url": "https://api.sprites.dev",
      "org": "[SNIP],
      "sprite": "[SNIP]",
      "last_used": "2026-01-24T13:57:30.032213-06:00"
    }
  }
}%

Likewise, cat ~/.sprites/sprites.json | grep api_token per this section doesn't work (obviously, you can see there's no api_token key in the JSON above).

Dominant language
TypeScript
Stars
51
Forks
4
Avg merge
23h 57m
Merged PRs (30d)
12

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from superfly/sprites-docs

All issues in superfly/sprites-docs

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.