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.
 

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Get the BMC (Baseboard Management Controller) access associated with the given ID.
+Get the BMC (Baseboard Management Controller) access associated with the ID, including the URL and login information needed to connect.
 
 USAGE:
   scw baremetal bmc get [arg=value ...]

@@ -1,16 +1,16 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Start BMC (Baseboard Management Controller) access associated with the given ID.
+Start BMC (Baseboard Management Controller) access associated with the ID.
 The BMC (Baseboard Management Controller) access is available one hour after the installation of the server.
-You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then you can add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do not forget to delete the Option.
- After start BMC, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f.
+You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd.
+After adding the BMC option, you need to Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f. Do not forget to delete the Option after use.
 
 USAGE:
   scw baremetal bmc start [arg=value ...]
 
 ARGS:
   server-id         ID of the server
-  ip                The IP authorized to connect to the given server
+  ip                The IP authorized to connect to the server
   [zone=fr-par-1]   Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1)
 
 FLAGS:

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Stop BMC (Baseboard Management Controller) access associated with the given ID.
+Stop BMC (Baseboard Management Controller) access associated with the ID.
 
 USAGE:
   scw baremetal bmc stop [arg=value ...]

@@ -1,18 +1,18 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server.
+A Baseboard Management Controller (BMC) allows you to remotely access the low-level parameters of your dedicated server.
 For instance, your KVM-IP management console could be accessed with it.
-You need first to create an option Remote Access. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then you can add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do not forget to delete the Option.
+You need first to create an Remote Access option. You will find the ID and the price with a call to listOffers (https://developers.scaleway.com/en/products/baremetal/api/#get-78db92). Then you can add the option https://developers.scaleway.com/en/products/baremetal/api/#post-b14abd. Do not forget to delete the Option.
 Then you need to create Remote Access https://developers.scaleway.com/en/products/baremetal/api/#post-1af723.
 And finally Get Remote Access to get the login/password https://developers.scaleway.com/en/products/baremetal/api/#get-cefc0f.
 
 USAGE:
   scw baremetal bmc <command>
 
 AVAILABLE COMMANDS:
-  get         Get BMC (Baseboard Management Controller) access for a given elastic metal server
-  start       Start BMC (Baseboard Management Controller) access for a given elastic metal server
-  stop        Stop BMC (Baseboard Management Controller) access for a given elastic metal server
+  get         Get BMC access
+  start       Start BMC access
+  stop        Stop BMC access
 
 FLAGS:
   -h, --help   help for bmc

@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Return specific offer for the given ID.
+Get details of an offer identified by its offer ID.
 
 USAGE:
   scw baremetal offer get [arg=value ...]
 
 EXAMPLES:
-  Get a server offer with the given ID
+  Get a server offer with the ID
     scw baremetal offer get zone=fr-par-1 offer-id=11111111-1111-1111-1111-111111111111
 
 ARGS:

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List all available server offers.
+List all available Elastic Metal server configurations.
 
 USAGE:
   scw baremetal offer list [arg=value ...]
@@ -13,7 +13,7 @@ EXAMPLES:
     scw baremetal offer list zone=fr-par-1
 
 ARGS:
-  [subscription-period]   Period of subscription to filter offers (unknown_subscription_period | hourly | monthly)
+  [subscription-period]   Subscription period type to filter offers by (unknown_subscription_period | hourly | monthly)
   [zone=fr-par-1]         Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | all)
 
 FLAGS:

@@ -1,7 +1,7 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Server offers will answer with all different elastic metal server ranges available in a given zone.
-Each of them will contain all the features of the server (cpus, memories, disks) with their associated pricing.
+Server offers will answer with all different Elastic Metal server ranges available in a  zone.
+Each of them will contain all the features of the server (CPUs, memory, disks) with their associated pricing.
 
 USAGE:
   scw baremetal offer <command>

@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Add an option to a specific server.
+Add an option, such as Private Networks, to a specific server.
 
 USAGE:
   scw baremetal options add [arg=value ...]
 
 EXAMPLES:
-  Add a given option to a server
+  Add an option, such as Private Networks, to a server
     scw baremetal options add server-id=11111111-1111-1111-1111-111111111111 option-id=11111111-1111-1111-1111-111111111111
 
 ARGS:

@@ -6,7 +6,7 @@ USAGE:
   scw baremetal options delete [arg=value ...]
 
 EXAMPLES:
-  Delete a given option from a server
+  Delete an option from a server
     scw baremetal options delete server-id=11111111-1111-1111-1111-111111111111 option-id=11111111-1111-1111-1111-111111111111
 
 ARGS:

@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Return specific option for the given ID.
+Return specific option for the ID.
 
 USAGE:
   scw baremetal options get [arg=value ...]
 
 EXAMPLES:
-  Get a server option with the given ID
+  Get a server option with the ID
     scw baremetal options get zone=fr-par-1 option-id=11111111-1111-1111-1111-111111111111
 
 ARGS:

@@ -13,8 +13,8 @@ EXAMPLES:
     scw baremetal options list zone=fr-par-1
 
 ARGS:
-  [offer-id]        Filter options by offer_id
-  [name]            Filter options by name
+  [offer-id]        Offer ID to filter options for
+  [name]            Name to filter options for
   [zone=fr-par-1]   Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | all)
 
 FLAGS:

@@ -1,6 +1,6 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Return specific OS for the given ID.
+Return specific OS for the ID.
 
 USAGE:
   scw baremetal os get <os-id ...> [arg=value ...]

@@ -1,12 +1,12 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-List all available OS that can be install on an elastic metal server.
+List all OSes that are available for installation on Elastic Metal servers.
 
 USAGE:
   scw baremetal os list [arg=value ...]
 
 ARGS:
-  [offer-id]        Filter OS by offer ID
+  [offer-id]        Offer IDs to filter OSes for
   [zone=fr-par-1]   Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1 | all)
 
 FLAGS:

@@ -6,8 +6,8 @@ USAGE:
   scw baremetal os <command>
 
 AVAILABLE COMMANDS:
-  get         Get an OS with a given ID
-  list        List all available OS that can be install on an elastic metal server
+  get         Get an OS with an ID
+  list        List available OSes
 
 FLAGS:
   -h, --help   help for os

@@ -1,13 +1,13 @@
 🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
 🟥🟥🟥 STDERR️️ 🟥🟥🟥️
-Add a server to a private network.
+Add a server to a Private Network.
 
 USAGE:
   scw baremetal private-network add [arg=value ...]
 
 ARGS:
   server-id            The ID of the server
-  private-network-id   The ID of the private network
+  private-network-id   The ID of the Private Network
   [zone=fr-par-1]      Zone to target. If none is passed will use default zone from the config (fr-par-2)
 
 FLAGS: