Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/SGizek/Raiku/llms.txt

Use this file to discover all available pages before exploring further.

raiku login stores a GitHub Personal Access Token (PAT) in ~/.raiku/auth.json so that raiku publish --submit can open pull requests on your behalf without you having to paste credentials every time. The token is verified against the GitHub API at login time so you know immediately whether it is valid. On POSIX systems the auth file is written with chmod 600 so only your user account can read it.

Usage

raiku login [--token TOKEN]
raiku whoami
raiku logout
CommandDescription
raiku loginPrompt for (or accept via --token) a GitHub PAT, verify it, and store it.
raiku whoamiDisplay the GitHub username associated with the stored token.
raiku logoutDelete the stored credentials from ~/.raiku/auth.json.

Flags for raiku login

FlagDescription
--token TOKENProvide the PAT directly (skips the interactive prompt). Useful for scripted setups.

What login stores

Raiku writes a JSON file at ~/.raiku/auth.json containing:
{
  "token": "ghp_xxxxxxxxxxxxxxxxxxxx",
  "username": "your-github-username",
  "name": "Your Full Name"
}
The file permissions are set to 600 on Linux and macOS. On Windows, file-level permission restriction is not applied but the file is still stored in your user home directory.

Required token scope

The PAT must have the repo scope to open pull requests against the Raiku repository. You can create a fine-grained token with Contents: Read and Pull requests: Write on the target repository, or use a classic PAT with repo. Create tokens at: github.com/settings/tokens

When is the token used?

The stored token is only used by raiku publish --submit. All other Raiku commands (install, sync, search, etc.) are unauthenticated and do not require a GitHub token.

Examples

raiku login
# GitHub Personal Access Token: ****

Sample output of raiku login

╭──────────────────────────────────────────╮
│ ✓ Logged in as your-username (Your Name) │
╰──────────────────────────────────────────╯
  Token stored at /home/user/.raiku/auth.json

  Use raiku publish --submit to open PRs automatically.

Sample output of raiku whoami

✓ Logged in as your-username (Your Name)
  Auth file: /home/user/.raiku/auth.json
Your token is validated against the GitHub API at login time to catch typos and expired tokens early. If the API is unreachable, Raiku saves the token anyway with a warning — it may still work when you run raiku publish --submit.
Keep your GitHub token private. Do not commit ~/.raiku/auth.json to source control or share it in logs. If a token is compromised, revoke it immediately at github.com/settings/tokens and run raiku logout followed by raiku login with a fresh token.

Build docs developers (and LLMs) love