docs: use INI format in README Quick Start config example - #221
Merged
jennlu330 merged 2 commits intoSep 3, 2026
Merged
Conversation
The default config auto-discovery path (no --config/IPCTL_CONFIG set) hardcodes the Viper config type to "ini", so a ~/.platform.d/config.toml found via auto-discovery is actually parsed with the INI decoder, not the TOML decoder. TOML-style quoted section headers like ["profile default"] get mangled by the INI parser, silently dropping the profile. Switch the Quick Start example to plain INI syntax so it matches what auto-discovery actually parses. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Naming a profile (e.g. "local") in config.ini isn't enough to make it active - without --profile or an [application] default_profile setting, ipctl silently falls back to its built-in empty default profile (port 0, resolved to 443). Show the [application] default_profile setting so the Quick Start example actually works without extra flags, and make the verify option explicit since it directly affects whether self-signed/local TLS certs are trusted. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
--config/IPCTL_CONFIGset) hardcodes the Viper config type to"ini"ininternal/config/loader.go'sloadConfigFile, so a~/.platform.d/config.tomlfound via auto-discovery is actually parsed with the INI decoder, not TOML.["profile default"]get mangled by the INI parser (which has no quoted-string support — seegopkg.in/ini.v1/parser.go), silently dropping the profile and its settings (e.g. a customport).[profile default], unquoted values), matching what auto-discovery actually parses today, so new users following the README don't hit a silent fallback to the wrong port/host.Note
This is a docs-only fix to match current default behavior. The underlying auto-discovery format-detection bug (only explicit
--config/IPCTL_CONFIGcorrectly auto-detects TOML/YAML/JSON by extension) is still open — happy to file a separate issue/PR for that if useful.Test plan
🤖 Generated with Claude Code