Separate backups/trash into XDG_DATA_HOME and logs into XDG_STATE_HOME instead of keeping everything under XDG_CONFIG_HOME. Add automatic migration at startup to move existing data to the new locations. Fix Windows path resolution: DataDir() and StateDir() now fall back to %AppData% on Windows (matching BaseDir()), preventing incorrect use of ~/.local/share and ~/.local/state paths. Add MigrateWindowsLegacyDir() to move pre-v0.13.0 data from ~\.config\skillshare\ to %AppData%\skillshare\ on Windows. Update doctor, oplog, backup, trash, and all tests/docs accordingly.
3.7 KiB
sidebar_position
| sidebar_position |
|---|
| 2 |
Environment Variables
All environment variables recognized by skillshare.
Configuration
SKILLSHARE_CONFIG
Override the config file path.
SKILLSHARE_CONFIG=~/custom-config.yaml skillshare status
Default: ~/.config/skillshare/config.yaml
XDG_CONFIG_HOME
Override the base configuration directory per the XDG Base Directory Specification.
export XDG_CONFIG_HOME=~/my-config
# skillshare will use ~/my-config/skillshare/
Default behavior:
| Platform | Default |
|---|---|
| Linux | ~/.config/skillshare/ |
| macOS | ~/.config/skillshare/ |
| Windows | %AppData%\skillshare\ |
Priority: SKILLSHARE_CONFIG > XDG_CONFIG_HOME > platform default.
:::note
If you set XDG_CONFIG_HOME after initial setup, move your existing ~/.config/skillshare/ directory to the new location manually.
:::
XDG_DATA_HOME
Override the data directory (backups, trash).
export XDG_DATA_HOME=~/my-data
# skillshare will use ~/my-data/skillshare/backups/ and ~/my-data/skillshare/trash/
Default: ~/.local/share/skillshare/
XDG_STATE_HOME
Override the state directory (operation logs).
export XDG_STATE_HOME=~/my-state
# skillshare will use ~/my-state/skillshare/logs/
Default: ~/.local/state/skillshare/
:::tip Automatic migration
Starting from v0.13.0, skillshare follows the XDG Base Directory Specification for backups, trash, and logs. If you're upgrading from an older version, these directories are automatically migrated from ~/.config/skillshare/ to their proper XDG locations on first run.
:::
GitHub API
GITHUB_TOKEN
GitHub personal access token for API requests.
When needed:
- Upgrading skillshare CLI
- Installing from private repos
- Hitting rate limits
Usage:
export GITHUB_TOKEN=ghp_your_token_here
skillshare upgrade
Creating a token:
- Go to https://github.com/settings/tokens
- Generate new token (classic)
- No scopes needed for public repos
- Copy the token
Windows:
# Current session
$env:GITHUB_TOKEN = "ghp_your_token"
# Permanent
[Environment]::SetEnvironmentVariable("GITHUB_TOKEN", "ghp_your_token", "User")
Testing
SKILLSHARE_TEST_BINARY
Override the CLI binary path for integration tests.
SKILLSHARE_TEST_BINARY=/path/to/skillshare go test ./tests/integration
Default: bin/skillshare in project root
Usage Examples
Temporary override
# Single command
SKILLSHARE_CONFIG=/tmp/test-config.yaml skillshare status
# Multiple commands
export SKILLSHARE_CONFIG=/tmp/test-config.yaml
skillshare status
skillshare list
unset SKILLSHARE_CONFIG
Permanent setup (macOS/Linux)
Add to ~/.bashrc or ~/.zshrc:
export GITHUB_TOKEN="ghp_your_token_here"
Permanent setup (Windows)
[Environment]::SetEnvironmentVariable("GITHUB_TOKEN", "ghp_your_token", "User")
Summary
| Variable | Purpose | Default |
|---|---|---|
SKILLSHARE_CONFIG |
Config file path | ~/.config/skillshare/config.yaml |
XDG_CONFIG_HOME |
Base config directory | ~/.config (Linux/macOS), %AppData% (Windows) |
XDG_DATA_HOME |
Data directory (backups, trash) | ~/.local/share |
XDG_STATE_HOME |
State directory (logs) | ~/.local/state |
GITHUB_TOKEN |
GitHub API auth | None |
SKILLSHARE_TEST_BINARY |
Test binary path | bin/skillshare |
Related
- Configuration — Config file reference
- Windows Issues — Windows environment setup