scaleway · Codelax · Mar 14, 2023 · Mar 14, 2023
@@ -1,13 +1,13 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Create project.
+Generate a new Project for an Organization, specifying its configuration including name and description.
 
 USAGE:
   scw account project create [arg=value ...]
 
 ARGS:
-  [name]              The name of the project
-  [description]       The description of the project
+  [name]              Name of the Project
+  [description]       Description of the Project
   [organization-id]   Organization ID to use. If none is passed the default organization ID will be used
 
 FLAGS:

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete project.
+Delete an existing Project, specified by its Project ID. The Project needs to be empty (meaning there are no resources left in it) to be deleted effectively. Note that deleting a Project is permanent, and cannot be undone.
 
 USAGE:
   scw account project delete [arg=value ...]

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Get project.
+Retrieve information about an existing Project, specified by its Project ID. Its full details, including ID, name and description, are returned in the response object.
 
 USAGE:
   scw account project get [arg=value ...]

@@ -1,14 +1,14 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List projects.
+List all Projects of an Organization. The response will include the total number of Projects as well as their associated Organizations, names and IDs. Other information include the creation and update date of the Project.
 
 USAGE:
   scw account project list [arg=value ...]
 
 ARGS:
-  [name]                  The name of the project
-  [order-by]              The sort order of the returned projects (created_at_asc | created_at_desc | name_asc | name_desc)
-  [project-ids.{index}]   Filter out by a list of project ID
+  [name]                  Name of the Project
+  [order-by]              Sort order of the returned Projects (created_at_asc | created_at_desc | name_asc | name_desc)
+  [project-ids.{index}]   Project IDs to filter for. The results will be limited to any Projects with an ID in this array
   [organization-id]       Organization ID to use. If none is passed the default organization ID will be used
 
 FLAGS:

@@ -1,14 +1,14 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Update project.
+Update the parameters of an existing Project, specified by its Project ID. These parameters include the name and description.
 
 USAGE:
   scw account project update [arg=value ...]
 
 ARGS:
   [project-id]    Project ID to use. If none is passed the default project ID will be used
-  [name]          The name of the project
-  [description]   The description of the project
+  [name]          Name of the Project
+  [description]   Description of the Project
 
 FLAGS:
   -h, --help   help for update

@@ -6,11 +6,11 @@ USAGE:
   scw account project <command>
 
 AVAILABLE COMMANDS:
-  create      Create project
-  delete      Delete project
-  get         Get project
-  list        List projects
-  update      Update project
+  create      Create a new Project for an Organization
+  delete      Delete an existing Project
+  get         Get an existing Project
+  list        List all Projects of an Organization
+  update      Update Project
 
 FLAGS:
   -h, --help   help for project

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Get an Operating System (OS).
+Get an Operating System (OS).  The response will include the OS's unique ID as well as its name and label.
 
 USAGE:
   scw apple-silicon os get <os-id ...> [arg=value ...]

@@ -1,13 +1,13 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List all Operating System (OS).
+List all Operating System (OS). The response will include the total number of OS as well as their associated IDs, names and labels.
 
 USAGE:
   scw apple-silicon os list [arg=value ...]
 
 ARGS:
-  [server-type]     List of compatible server type
-  [name]            Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not "12")
+  [server-type]     List of compatible server types
+  [name]            Filter OS by name (note that "11.1" will return "11.1.2" and "11.1" but not "12"))
   [zone=fr-par-1]   Zone to target. If none is passed will use default zone from the config (fr-par-3 | all)
 
 FLAGS:

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Create a server.
+Create a new server in the targeted zone, specifying its configuration including name and type.
 
 USAGE:
   scw apple-silicon server create [arg=value ...]

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Delete a server.
+Delete an existing Apple silicon server, specified by its server ID. Deleting a server is permanent, and cannot be undone. Note that the minimum allocation period for Apple silicon-as-a-service is 24 hours, meaning you cannot delete your server prior to that.
 
 USAGE:
   scw apple-silicon server delete <server-id ...> [arg=value ...]

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Get a server.
+Retrieve information about an existing Apple silicon server, specified by its server ID. Its full details, including name, status and IP address, are returned in the response object.
 
 USAGE:
   scw apple-silicon server get <server-id ...> [arg=value ...]

@@ -1,14 +1,14 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List all servers.
+List all servers in the specified zone. By default, returned servers in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
 
 USAGE:
   scw apple-silicon server list [arg=value ...]
 
 ARGS:
-  [order-by]          The sort order of the returned servers (created_at_asc | created_at_desc)
-  [project-id]        List only servers of this project ID
-  [organization-id]   List only servers of this organization ID
+  [order-by]          Sort order of the returned servers (created_at_asc | created_at_desc)
+  [project-id]        Only list servers of this project ID
+  [organization-id]   Only list servers of this Organization ID
   [zone=fr-par-1]     Zone to target. If none is passed will use default zone from the config (fr-par-3 | all)
 
 FLAGS:

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Reboot a server.
+Reboot an existing Apple silicon server, specified by its server ID.
 
 USAGE:
   scw apple-silicon server reboot <server-id ...> [arg=value ...]

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Reinstall a server.
+Reinstall an existing Apple silicon server (specified by its server ID) from a new image (OS). All the data on the disk is deleted and all configuration is reset to the defailt configuration values of the image (OS).
 
 USAGE:
   scw apple-silicon server reinstall <server-id ...> [arg=value ...]

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List all server types technical details.
+List all technical details about Apple silicon server types available in the specified zone. Since there is only one Availability Zone for Apple silicon servers, the targeted value is `fr-par-3`.
 
 USAGE:
   scw apple-silicon server-type list [arg=value ...]

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Update a server.
+Update the parameters of an existing Apple silicon server, specified by its server ID.
 
 USAGE:
   scw apple-silicon server update <name ...> [arg=value ...]

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Scaleway Apple silicon M1 as-a-Service is built using the latest generation of Apple Mac mini hardware (fifth generation).
+Scaleway Apple silicon as-a-Service is built using the latest generation of Apple Mac mini hardware (fifth generation).
 
 These dedicated Mac mini M1s are designed for developing, building, testing, and signing applications for Apple devices, including iPhones, iPads, Mac computers and much more.
 

@@ -3,21 +3,21 @@
 This API allows you to manage projects.
 
 - [Project management commands](#project-management-commands)
-  - [Create project](#create-project)
-  - [Delete project](#delete-project)
-  - [Get project](#get-project)
-  - [List projects](#list-projects)
-  - [Update project](#update-project)
+  - [Create a new Project for an Organization](#create-a-new-project-for-an-organization)
+  - [Delete an existing Project](#delete-an-existing-project)
+  - [Get an existing Project](#get-an-existing-project)
+  - [List all Projects of an Organization](#list-all-projects-of-an-organization)
+  - [Update Project](#update-project)
 
 
 ## Project management commands
 
 Project management commands.
 
 
-### Create project
+### Create a new Project for an Organization
 
-Create project.
+Generate a new Project for an Organization, specifying its configuration including name and description.
 
 **Usage:**
 
@@ -30,15 +30,15 @@ scw account project create [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| name |  | The name of the project |
-| description |  | The description of the project |
+| name |  | Name of the Project |
+| description |  | Description of the Project |
 | organization-id |  | Organization ID to use. If none is passed the default organization ID will be used |
 
 
 
-### Delete project
+### Delete an existing Project
 
-Delete project.
+Delete an existing Project, specified by its Project ID. The Project needs to be empty (meaning there are no resources left in it) to be deleted effectively. Note that deleting a Project is permanent, and cannot be undone.
 
 **Usage:**
 
@@ -55,9 +55,9 @@ scw account project delete [arg=value ...]
 
 
 
-### Get project
+### Get an existing Project
 
-Get project.
+Retrieve information about an existing Project, specified by its Project ID. Its full details, including ID, name and description, are returned in the response object.
 
 **Usage:**
 
@@ -74,9 +74,9 @@ scw account project get [arg=value ...]
 
 
 
-### List projects
+### List all Projects of an Organization
 
-List projects.
+List all Projects of an Organization. The response will include the total number of Projects as well as their associated Organizations, names and IDs. Other information include the creation and update date of the Project.
 
 **Usage:**
 
@@ -89,16 +89,16 @@ scw account project list [arg=value ...]
 
 | Name |   | Description |
 |------|---|-------------|
-| name |  | The name of the project |
-| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | The sort order of the returned projects |
-| project-ids.{index} |  | Filter out by a list of project ID |
+| name |  | Name of the Project |
+| order-by | One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc` | Sort order of the returned Projects |
+| project-ids.{index} |  | Project IDs to filter for. The results will be limited to any Projects with an ID in this array |
 | organization-id |  | Organization ID to use. If none is passed the default organization ID will be used |
 
 
 
-### Update project
+### Update Project
 
-Update project.
+Update the parameters of an existing Project, specified by its Project ID. These parameters include the name and description.
 
 **Usage:**
 
@@ -112,8 +112,8 @@ scw account project update [arg=value ...]
 | Name |   | Description |
 |------|---|-------------|
 | project-id |  | Project ID to use. If none is passed the default project ID will be used |
-| name |  | The name of the project |
-| description |  | The description of the project |
+| name |  | Name of the Project |
+| description |  | Description of the Project |