Skip to content

Conversation

@joshrotenberg
Copy link
Collaborator

Summary

Quick documentation improvement to make profile configuration more discoverable.

Part of #251

Changes

  • Added profile storage locations to README after the profile creation example
  • Shows platform-specific paths:
    • Linux/macOS: ~/.config/redisctl/config.toml
    • Windows: %APPDATA%\redis\redisctl\config.toml

Impact

  • Users can now easily find where their profiles are stored
  • Helpful for manual editing or troubleshooting
  • Makes configuration more transparent

Next Steps

As noted in #251, we should also:

  • Add profile path command to show config location
  • Show path in profile list output
  • Add path info to profile set success message

- Added clear documentation of where profiles are stored on each platform
- Linux/macOS: ~/.config/redisctl/config.toml
- Windows: %APPDATA%\redis\redisctl\config.toml
- Helps users understand where their configuration is saved

Part of #251
@joshrotenberg joshrotenberg added the documentation Improvements or additions to documentation label Sep 10, 2025
@joshrotenberg joshrotenberg merged commit 0329b56 into main Sep 10, 2025
9 checks passed
@joshrotenberg joshrotenberg deleted the docs/add-profile-locations branch September 10, 2025 19:48
This was referenced Sep 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants