Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 27, 2025

The CLI documentation incorrectly stated the global settings file path as $HOME/.aspire/settings.json. The actual path is $HOME/.aspire/globalsettings.json.

Changes

  • Updated global settings file path in docs/cli/config-settings.md
  • Updated --global option descriptions in aspire-config-delete.md and aspire-config-set.md
  • Updated shared include file config-file-description.md

Local settings file references (./.aspire/settings.json) remain unchanged.

Original prompt

The CLI docs for aspire incorrectly state that the global settings file is located at $HOME/.aspire/settings.json. This is not correct, the actual file path is $HOME/.aspire/globalsettings.json. Review the documentation and make sure this is updated.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.


Internal previews

📄 File 🔗 Preview link
docs/cli-reference/aspire-config-delete.md docs/cli-reference/aspire-config-delete
docs/cli-reference/aspire-config-set.md docs/cli-reference/aspire-config-set
docs/cli/config-settings.md docs/cli/config-settings

…ettings.json

Co-authored-by: mitchdenny <513398+mitchdenny@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix incorrect global settings file path in CLI docs Fix global settings file path: settings.json → globalsettings.json Oct 27, 2025
Copilot AI requested a review from mitchdenny October 27, 2025 03:39
Copilot finished work on behalf of mitchdenny October 27, 2025 03:39
@mitchdenny
Copy link
Member

/cc @IEvangelist for review.

@mitchdenny mitchdenny marked this pull request as ready for review October 27, 2025 03:41
Copilot AI review requested due to automatic review settings October 27, 2025 03:41
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR corrects an error in the Aspire CLI documentation where the global settings file path was incorrectly documented as $HOME/.aspire/settings.json. The correct path is $HOME/.aspire/globalsettings.json. The changes ensure consistency across all documentation that references the global settings file location.

Key changes:

  • Updated global settings file path from settings.json to globalsettings.json in all relevant documentation
  • Local settings file path (./.aspire/settings.json) correctly remains unchanged

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
docs/cli/config-settings.md Updated global settings file path in the config file locations section
docs/cli-reference/includes/config-file-description.md Corrected global settings path in the shared include file used across multiple CLI reference pages
docs/cli-reference/aspire-config-set.md Fixed global settings path in the --global option description
docs/cli-reference/aspire-config-delete.md Fixed global settings path in the --global option description

@mitchdenny mitchdenny enabled auto-merge (squash) October 27, 2025 03:58
@mitchdenny mitchdenny merged commit 6d64ba5 into main Oct 27, 2025
16 checks passed
@mitchdenny mitchdenny deleted the copilot/fix-cli-docs-global-settings-path branch October 27, 2025 19:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants