Skip to content

Commit 517c57e

Browse files
author
serverpod_cloud
committed
docs: 909c53a68e2bfa51ed462cc79a18cb65018e3ac5
1 parent fed5f06 commit 517c57e

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

serverpod_cloud_cli/lib/command_runner/commands/project_command.dart

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,18 @@ class CloudProjectLinkCommand
164164
extends CloudCliCommand<ProjectLinkCommandOption> {
165165
@override
166166
String get description =>
167-
'Link your local project to an existing Serverpod Cloud project.';
167+
'Link your local project to an existing Serverpod Cloud project.\n'
168+
'\n'
169+
'This command creates or updates the project configuration files in your local '
170+
'codebase to connect it to an existing Serverpod Cloud project. It will:\n'
171+
' - Create or update the scloud.yaml configuration file with the project ID\n'
172+
' - Create a .scloudignore file if it does not exist\n'
173+
' - Update .gitignore to exclude the .scloud/ directory (if in a workspace)\n'
174+
'\n'
175+
'The scloud.yaml file contains the project ID and is used by other scloud commands '
176+
'to identify which Serverpod Cloud project to use. This file can be safely '
177+
'committed to version control as it only contains the project identifier, not '
178+
'sensitive credentials.';
168179

169180
@override
170181
String get name => 'link';

0 commit comments

Comments
 (0)