Skip to content

chore: fix documentation for scw info#5653

Draft
remyleone wants to merge 6 commits into
mainfrom
add_documentation
Draft

chore: fix documentation for scw info#5653
remyleone wants to merge 6 commits into
mainfrom
add_documentation

Conversation

@remyleone

Copy link
Copy Markdown
Member

Community Note

  • Please vote on this pull request by adding a 👍 reaction to the original pull request comment to help the community and maintainers prioritize this request.
  • Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for pull request followers and do not help prioritize the request

Relates OR Closes #0000

Release note for CHANGELOG:


Copilot AI review requested due to automatic review settings June 8, 2026 11:41
@remyleone remyleone requested a review from a team as a code owner June 8, 2026 11:41
@remyleone remyleone requested review from jremy42 and removed request for a team June 8, 2026 11:41
Comment thread docs/commands/login.md
@remyleone remyleone marked this pull request as draft June 8, 2026 11:45
@codecov-commenter

codecov-commenter commented Jun 8, 2026

Copy link
Copy Markdown

❌ 8 Tests Failed:

Tests completed Failed Passed Skipped
2413 8 2405 17
View the top 3 failed test(s) by shortest run time
github.com/scaleway/scaleway-cli/v2/cmd/scw::Test_AllUsage/config_get_usage
Stack Traces | 0.01s run time
=== RUN   Test_AllUsage/config_get_usage
=== PAUSE Test_AllUsage/config_get_usage
=== CONT  Test_AllUsage/config_get_usage
    main_test.go:37: 
        	Error Trace:	.../scaleway-cli/core/testing.go:780
        	            				.../scaleway-cli/core/testing.go:693
        	            				.../scaleway-cli/core/testing.go:523
        	Error:      	Not equal: 
        	            	expected: "🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲\n🟩🟩🟩 STDOUT️ 🟩🟩🟩️\nGet a value from the config file\n\nUSAGE:\n  scw config get <key ...> [arg=value ...]\n\nEXAMPLES:\n  Get the default organization ID\n    scw config get default_organization_id\n\n  Get the default region of the profile 'prod'\n    scw -p prod config get default_region\n\nARGS:\n  key   the key to get from the config (access-key | secret-key | api-url | insecure | default-organization-id | default-project-id | default-region | default-zone | send-telemetry)\n\nFLAGS:\n  -h, --help                help for get\n      --list-sub-commands   List all subcommands\n\nGLOBAL FLAGS:\n  -c, --config string    The path to the config file\n  -D, --debug            Enable debug mode\n  -o, --output string    Output format: json or human, see 'scw help output' for more info (default \"human\")\n  -p, --profile string   The config profile to use\n\nSEE ALSO:\n  # Config management help\n  scw config\n"
        	            	actual  : "🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲\n🟩🟩🟩 STDOUT️ 🟩🟩🟩️\nGet a value from the config file\n\nUSAGE:\n  scw config get <key ...> [arg=value ...]\n\nEXAMPLES:\n  Get the default organization ID\n    scw config get default_organization_id\n\n  Get the default region of the profile 'prod'\n    scw -p prod config get default_region\n\nARGS:\n  key   the key to get from the config (access-key | secret-key | api-url | insecure | default-organization-id | default-project-id | default-region | default-zone | send-telemetry)\n\nFLAGS:\n  -h, --help                help for get\n      --list-sub-commands   List all subcommands\n\nGLOBAL FLAGS:\n  -c, --config string    The path to the config file\n  -D, --debug            Enable debug mode\n  -o, --output string    Output format: json or human, see 'scw help output' for more info (default \"human\")\n  -p, --profile string   The config profile to use\n\nSEE ALSO:\n  # Config management help\n  scw config\n\n  # See current configuration\n  scw info\n"
        	            	
        	            	Diff:
        	            	--- Expected
        	            	+++ Actual
        	            	@@ -31 +31,4 @@
        	            	 
        	            	+  # See current configuration
        	            	+  scw info
        	            	+
        	Test:       	Test_AllUsage/config_get_usage
--- FAIL: Test_AllUsage/config_get_usage (0.01s)
github.com/scaleway/scaleway-cli/v2/cmd/scw::Test_AllUsage/config_info_usage
Stack Traces | 0.01s run time
=== RUN   Test_AllUsage/config_info_usage
=== PAUSE Test_AllUsage/config_info_usage
=== CONT  Test_AllUsage/config_info_usage
    main_test.go:37: 
        	Error Trace:	.../scaleway-cli/core/testing.go:780
        	            				.../scaleway-cli/core/testing.go:693
        	            				.../scaleway-cli/core/testing.go:523
        	Error:      	Not equal: 
        	            	expected: "🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲\n🟩🟩🟩 STDOUT️ 🟩🟩🟩️\nGet config values from the config file for the current profile\n\nUSAGE:\n  scw config info\n\nEXAMPLES:\n  Get the default config values\n    scw config info\n\n  Get the config values of the profile 'prod'\n    scw -p prod config info\n\nFLAGS:\n  -h, --help                help for info\n      --list-sub-commands   List all subcommands\n\nGLOBAL FLAGS:\n  -c, --config string    The path to the config file\n  -D, --debug            Enable debug mode\n  -o, --output string    Output format: json or human, see 'scw help output' for more info (default \"human\")\n  -p, --profile string   The config profile to use\n\nSEE ALSO:\n  # Config management help\n  scw config\n"
        	            	actual  : "🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲\n🟩🟩🟩 STDOUT️ 🟩🟩🟩️\nGet config values from the config file for the current profile\n\nUSAGE:\n  scw config info\n\nEXAMPLES:\n  Get the default config values\n    scw config info\n\n  Get the config values of the profile 'prod'\n    scw -p prod config info\n\nFLAGS:\n  -h, --help                help for info\n      --list-sub-commands   List all subcommands\n\nGLOBAL FLAGS:\n  -c, --config string    The path to the config file\n  -D, --debug            Enable debug mode\n  -o, --output string    Output format: json or human, see 'scw help output' for more info (default \"human\")\n  -p, --profile string   The config profile to use\n\nSEE ALSO:\n  # Config management help\n  scw config\n\n  # See current configuration\n  scw info\n"
        	            	
        	            	Diff:
        	            	--- Expected
        	            	+++ Actual
        	            	@@ -28 +28,4 @@
        	            	 
        	            	+  # See current configuration
        	            	+  scw info
        	            	+
        	Test:       	Test_AllUsage/config_info_usage
--- FAIL: Test_AllUsage/config_info_usage (0.01s)
github.com/scaleway/scaleway-cli/v2/cmd/scw::Test_AllUsage/login_usage
Stack Traces | 0.01s run time
=== RUN   Test_AllUsage/login_usage
=== PAUSE Test_AllUsage/login_usage
=== CONT  Test_AllUsage/login_usage
    main_test.go:37: 
        	Error Trace:	.../scaleway-cli/core/testing.go:780
        	            				.../scaleway-cli/core/testing.go:693
        	            				.../scaleway-cli/core/testing.go:523
        	Error:      	Not equal: 
        	            	expected: "🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲\n🟩🟩🟩 STDOUT️ 🟩🟩🟩️\nStart an interactive connection to scaleway to initialize the active profile of the config\nA webpage will open while the CLI will wait for a response.\nOnce you connected to Scaleway, the profile should be configured.\n\nUSAGE:\n  scw login [arg=value ...]\n\nARGS:\n  [port]         The port number used to wait for browser's response\n  [expires-at]   Expiration date of the API key (ISO 8601 or relative like +1y, +90d). Required when your organization enforces max-api-key-expiration-duration.\n\nFLAGS:\n  -h, --help                help for login\n      --list-sub-commands   List all subcommands\n\nGLOBAL FLAGS:\n  -c, --config string    The path to the config file\n  -D, --debug            Enable debug mode\n  -o, --output string    Output format: json or human, see 'scw help output' for more info (default \"human\")\n  -p, --profile string   The config profile to use\n\nSEE ALSO:\n  # Init profile manually\n  scw init\n"
        	            	actual  : "🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲\n🟩🟩🟩 STDOUT️ 🟩🟩🟩️\nStart an interactive connection to scaleway to initialize the active profile of the config\nA webpage will open while the CLI will wait for a response.\nOnce you connected to Scaleway, the profile should be configured.\n\nUSAGE:\n  scw login [arg=value ...]\n\nARGS:\n  [port]         The port number used to wait for browser's response\n  [expires-at]   Expiration date of the API key (ISO 8601 or relative like +1y, +90d). Required when your organization enforces max-api-key-expiration-duration.\n\nFLAGS:\n  -h, --help                help for login\n      --list-sub-commands   List all subcommands\n\nGLOBAL FLAGS:\n  -c, --config string    The path to the config file\n  -D, --debug            Enable debug mode\n  -o, --output string    Output format: json or human, see 'scw help output' for more info (default \"human\")\n  -p, --profile string   The config profile to use\n\nSEE ALSO:\n  # Init profile manually\n  scw init\n\n  # See current configuration\n  scw info\n"
        	            	
        	            	Diff:
        	            	--- Expected
        	            	+++ Actual
        	            	@@ -27 +27,4 @@
        	            	 
        	            	+  # See current configuration
        	            	+  scw info
        	            	+
        	Test:       	Test_AllUsage/login_usage
--- FAIL: Test_AllUsage/login_usage (0.01s)
github.com/scaleway/scaleway-cli/v2/cmd/scw::Test_AllUsage/feedback_bug_usage
Stack Traces | 0.02s run time
=== RUN   Test_AllUsage/feedback_bug_usage
=== PAUSE Test_AllUsage/feedback_bug_usage
=== CONT  Test_AllUsage/feedback_bug_usage
    main_test.go:37: 
        	Error Trace:	.../scaleway-cli/core/testing.go:780
        	            				.../scaleway-cli/core/testing.go:693
        	            				.../scaleway-cli/core/testing.go:523
        	Error:      	Not equal: 
        	            	expected: "🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲\n🟩🟩🟩 STDOUT️ 🟩🟩🟩️\nSend a bug-report to the Scaleway CLI team.\n\nUSAGE:\n  scw feedback bug\n\nFLAGS:\n  -h, --help                help for bug\n      --list-sub-commands   List all subcommands\n\nGLOBAL FLAGS:\n  -c, --config string    The path to the config file\n  -D, --debug            Enable debug mode\n  -o, --output string    Output format: json or human, see 'scw help output' for more info (default \"human\")\n  -p, --profile string   The config profile to use\n"
        	            	actual  : "🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲\n🟩🟩🟩 STDOUT️ 🟩🟩🟩️\nSend a bug-report to the Scaleway CLI team on the GitHub repository.\n\nUSAGE:\n  scw feedback bug\n\nEXAMPLES:\n  Send a bug report\n    scw feedback bug\n\nFLAGS:\n  -h, --help                help for bug\n      --list-sub-commands   List all subcommands\n\nGLOBAL FLAGS:\n  -c, --config string    The path to the config file\n  -D, --debug            Enable debug mode\n  -o, --output string    Output format: json or human, see 'scw help output' for more info (default \"human\")\n  -p, --profile string   The config profile to use\n\nSEE ALSO:\n  # See current configuration\n  scw info\n"
        	            	
        	            	Diff:
        	            	--- Expected
        	            	+++ Actual
        	            	@@ -2,3 +2,3 @@
        	            	 🟩🟩🟩 STDOUT️ 🟩🟩🟩️
        	            	-Send a bug-report to the Scaleway CLI team.
        	            	+Send a bug-report to the Scaleway CLI team on the GitHub repository.
        	            	 
        	            	@@ -6,2 +6,6 @@
        	            	   scw feedback bug
        	            	+
        	            	+EXAMPLES:
        	            	+  Send a bug report
        	            	+    scw feedback bug
        	            	 
        	            	@@ -17 +21,5 @@
        	            	 
        	            	+SEE ALSO:
        	            	+  # See current configuration
        	            	+  scw info
        	            	+
        	Test:       	Test_AllUsage/feedback_bug_usage
--- FAIL: Test_AllUsage/feedback_bug_usage (0.02s)
github.com/scaleway/scaleway-cli/v2/cmd/scw::Test_AllUsage/info_usage
Stack Traces | 0.02s run time
=== RUN   Test_AllUsage/info_usage
=== PAUSE Test_AllUsage/info_usage
=== CONT  Test_AllUsage/info_usage
    main_test.go:37: 
        	Error Trace:	.../scaleway-cli/core/testing.go:780
        	            				.../scaleway-cli/core/testing.go:693
        	            				.../scaleway-cli/core/testing.go:523
        	Error:      	Not equal: 
        	            	expected: "🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲\n🟩🟩🟩 STDOUT️ 🟩🟩🟩️\nGet info about current settings\n\nUSAGE:\n  scw info [arg=value ...]\n\nARGS:\n  [show-secret=false]   Reveal secret\n\nFLAGS:\n  -h, --help                help for info\n      --list-sub-commands   List all subcommands\n\nGLOBAL FLAGS:\n  -c, --config string    The path to the config file\n  -D, --debug            Enable debug mode\n  -o, --output string    Output format: json or human, see 'scw help output' for more info (default \"human\")\n  -p, --profile string   The config profile to use\n"
        	            	actual  : "🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲\n🟩🟩🟩 STDOUT️ 🟩🟩🟩️\nGet info about current settings.\n\nUSAGE:\n  scw info [arg=value ...]\n\nEXAMPLES:\n  See current configuration\n    scw info  \n\nARGS:\n  [show-secret=false]   Reveal secret\n\nFLAGS:\n  -h, --help                help for info\n      --list-sub-commands   List all subcommands\n\nGLOBAL FLAGS:\n  -c, --config string    The path to the config file\n  -D, --debug            Enable debug mode\n  -o, --output string    Output format: json or human, see 'scw help output' for more info (default \"human\")\n  -p, --profile string   The config profile to use\n"
        	            	
        	            	Diff:
        	            	--- Expected
        	            	+++ Actual
        	            	@@ -2,3 +2,3 @@
        	            	 🟩🟩🟩 STDOUT️ 🟩🟩🟩️
        	            	-Get info about current settings
        	            	+Get info about current settings.
        	            	 
        	            	@@ -6,2 +6,6 @@
        	            	   scw info [arg=value ...]
        	            	+
        	            	+EXAMPLES:
        	            	+  See current configuration
        	            	+    scw info  
        	            	 
        	Test:       	Test_AllUsage/info_usage
--- FAIL: Test_AllUsage/info_usage (0.02s)
github.com/scaleway/scaleway-cli/v2/cmd/scw::Test_AllUsage/version_usage
Stack Traces | 0.02s run time
=== RUN   Test_AllUsage/version_usage
=== PAUSE Test_AllUsage/version_usage
=== CONT  Test_AllUsage/version_usage
    main_test.go:37: 
        	Error Trace:	.../scaleway-cli/core/testing.go:780
        	            				.../scaleway-cli/core/testing.go:693
        	            				.../scaleway-cli/core/testing.go:523
        	Error:      	Not equal: 
        	            	expected: "🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲\n🟩🟩🟩 STDOUT️ 🟩🟩🟩️\nDisplay cli version\n\nUSAGE:\n  scw version\n\nFLAGS:\n  -h, --help                help for version\n      --list-sub-commands   List all subcommands\n\nGLOBAL FLAGS:\n  -c, --config string    The path to the config file\n  -D, --debug            Enable debug mode\n  -o, --output string    Output format: json or human, see 'scw help output' for more info (default \"human\")\n  -p, --profile string   The config profile to use\n"
        	            	actual  : "🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲\n🟩🟩🟩 STDOUT️ 🟩🟩🟩️\nDisplay cli version\n\nUSAGE:\n  scw version\n\nFLAGS:\n  -h, --help                help for version\n      --list-sub-commands   List all subcommands\n\nGLOBAL FLAGS:\n  -c, --config string    The path to the config file\n  -D, --debug            Enable debug mode\n  -o, --output string    Output format: json or human, see 'scw help output' for more info (default \"human\")\n  -p, --profile string   The config profile to use\n\nSEE ALSO:\n  # See current configuration\n  scw info\n"
        	            	
        	            	Diff:
        	            	--- Expected
        	            	+++ Actual
        	            	@@ -17 +17,5 @@
        	            	 
        	            	+SEE ALSO:
        	            	+  # See current configuration
        	            	+  scw info
        	            	+
        	Test:       	Test_AllUsage/version_usage
--- FAIL: Test_AllUsage/version_usage (0.02s)
github.com/scaleway/scaleway-cli/v2/cmd/scw::Test_AllUsage/feedback_feature_usage
Stack Traces | 0.04s run time
=== RUN   Test_AllUsage/feedback_feature_usage
=== PAUSE Test_AllUsage/feedback_feature_usage
=== CONT  Test_AllUsage/feedback_feature_usage
    main_test.go:37: 
        	Error Trace:	.../scaleway-cli/core/testing.go:780
        	            				.../scaleway-cli/core/testing.go:693
        	            				.../scaleway-cli/core/testing.go:523
        	Error:      	Not equal: 
        	            	expected: "🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲\n🟩🟩🟩 STDOUT️ 🟩🟩🟩️\nSend a feature request to the Scaleway CLI team.\n\nUSAGE:\n  scw feedback feature\n\nFLAGS:\n  -h, --help                help for feature\n      --list-sub-commands   List all subcommands\n\nGLOBAL FLAGS:\n  -c, --config string    The path to the config file\n  -D, --debug            Enable debug mode\n  -o, --output string    Output format: json or human, see 'scw help output' for more info (default \"human\")\n  -p, --profile string   The config profile to use\n"
        	            	actual  : "🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲\n🟩🟩🟩 STDOUT️ 🟩🟩🟩️\nSend a feature request to the Scaleway CLI team.\n\nUSAGE:\n  scw feedback feature\n\nEXAMPLES:\n  Send a feedback\n    scw feedback feature\n\nFLAGS:\n  -h, --help                help for feature\n      --list-sub-commands   List all subcommands\n\nGLOBAL FLAGS:\n  -c, --config string    The path to the config file\n  -D, --debug            Enable debug mode\n  -o, --output string    Output format: json or human, see 'scw help output' for more info (default \"human\")\n  -p, --profile string   The config profile to use\n\nSEE ALSO:\n  # See current configuration\n  scw info\n"
        	            	
        	            	Diff:
        	            	--- Expected
        	            	+++ Actual
        	            	@@ -6,2 +6,6 @@
        	            	   scw feedback feature
        	            	+
        	            	+EXAMPLES:
        	            	+  Send a feedback
        	            	+    scw feedback feature
        	            	 
        	            	@@ -17 +21,5 @@
        	            	 
        	            	+SEE ALSO:
        	            	+  # See current configuration
        	            	+  scw info
        	            	+
        	Test:       	Test_AllUsage/feedback_feature_usage
--- FAIL: Test_AllUsage/feedback_feature_usage (0.04s)
github.com/scaleway/scaleway-cli/v2/cmd/scw::Test_AllUsage
Stack Traces | 4.21s run time
=== RUN   Test_AllUsage
--- FAIL: Test_AllUsage (4.21s)

To view more test analytics, go to the Test Analytics Dashboard
📋 Got 3 mins? Take this short survey to help us improve Test Analytics.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

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