snapctl 0.44.1__py3-none-any.whl → 0.46.0__py3-none-any.whl

{snapctl-0.44.1.dist-info → snapctl-0.46.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: snapctl
-Version: 0.44.1
+Version: 0.46.0
 Summary: Snapser CLI Tool
 Author: Ajinkya Apte
 Author-email: aj@snapser.com
@@ -13,6 +13,7 @@ Requires-Dist: configparser (>=6.0.0,<7.0.0)
 Requires-Dist: pyfiglet (>=1.0.2,<2.0.0)
 Requires-Dist: pytest (>=8.2.2,<9.0.0)
 Requires-Dist: pytest-mock (>=3.14.0,<4.0.0)
+Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
 Requires-Dist: requests (>=2.28.2,<3.0.0)
 Requires-Dist: typer[all] (>=0.12.3,<0.13.0)
 Description-Content-Type: text/markdown
@@ -22,6 +23,61 @@ Description-Content-Type: text/markdown
 Snapser has developed a CLI tool called **snapctl** that can be used on MaxOSX, Linux and Windows machines.
 Snapctl will be the best way for game studios to integrate Snapser into their build pipelines.
 
+## What's new in the latest version?
+### Breaking Changes
+- **BYOSnap**:
+  - BYOSnap commands like `publish`, `sync` and `upload-docs` now take BYOSnap ID as a
+    non-positional argument. You now have to pass the BYOSnap Id using `--byosnap-id`.
+    ```bash
+    # Previously
+    snapctl byosnap publish byosnap-jinks-flask --version "v0.0.1" --path $path
+
+    # New
+    snapctl byosnap publish --byosnap-id byosnap-jinks-flask --version "v0.0.1" --path  $path
+    ```
+  - BYOSnap input parameter `--byosnap-profile-file` has been renamed to `--profile-filename`
+
+- **Generate**: The ability to generate a base BYOSnap profile using the `generate` command has
+  been deprecated. Instead its moved under `byosnap` commands for consistency.
+
+- **Snapend**:
+  - The manifest path variable has been changed for Snapend commands like `apply` and `clone`
+    from `--manifest-path` to `--manifest-path-filename`, for consistency with our new
+    variable naming nomenclature.
+  - The Snapend download command has new variable names like `format` and `type`. This is to add
+    more consistency and clarity to the command.
+    ```bash
+    # Previously
+    # snapctl snapend download --snapend-id gx5x6bc0 --category sdk --type unity --sdk-access-type external --sdk-auth-type user --out-path .
+
+    # New
+    snapctl snapend download --snapend-id gx5x6bc0 --category sdk --format unity --type user --out-path .
+    ```
+
+- Input param `--docker` for BYOGS and BYOSnap commands has been changed to `--docker_filename`
+
+### New Commands
+- **BYOSnap Generate Profile**: You can now use a new command to generate a base BYOSnap profile.
+  ```bash
+  snapctl byosnap generate-profile --out-path $outputPath --profile-filename $profileName
+  ```
+- **BYOSnap Validate Profile**: After you hand edit the base BYOSnap profile, you can use this
+  command to validate your BYOSnap profile before using it in other commands like `publish` and `sync`
+  ```bash
+  snapctl byosnap validate-profile --path $path --profile-filename $profileName
+  # or
+  snapctl byosnap validate-profile --resources-path $resources_path --profile-filename $profileName
+  ```
+- **Release Notes**: You can now view release notes for a specific version of Snapctl using the
+  `release-notes` command.
+  ```bash
+  snapctl release-notes releases
+  snapctl release-notes show
+  # or
+  snapctl release-notes show --version $version
+  ```
+
+## Requirements
 ### Python 3.X and Pip
 The Snapser CLI tool depends on Python 3.X and Pip. MacOS comes pre installed with Python. But
 please make sure you are running Python 3.X. On Windows, you can download Python 3.X from the
@@ -117,7 +173,7 @@ will look for the config file at that path.
 
 ```
 [default]
-snapser_access_key = <key>
+snapser_access_key = $your_api_key
 ```
 
 Or you can run the following command
@@ -176,11 +232,17 @@ setx SNAPSER_PROFILE="my_profile_name";
 
 Or you can pass **--profile my_profile_name** with every command to tell Snapser to use a particular profile.
 
+## Command variable name nomenclature
+All commands follow these rules with their input variables
+1. A variable that is named `*path` = CLI tool expects a path to a **folder**
+2. A variable that is named `*filename` = CLI tool expects the name of the file, without the path.
+3. A variable that is named `*path_filename` = CLI tool expects the full path. The folder up to the name of the file.
+
 ## Commands
 
 Run the following to see the list of commands Snapser supports
 
-```
+```bash
 snapctl --help
 ```
 
@@ -192,11 +254,52 @@ Snapctl commands for your custom code
 See all the supported commands. You should mainly need the `publish` and `sync` commands.
 All the others are for CRUD operations.
 
-```
+```bash
 # Help for the byosnap command
 snapctl byosnap --help
 ```
-#### 2. publish
+
+### 2. byosnap generate-profile
+
+This command generates a base BYOSnap profile. You will have to update the values within this file
+and then you can use it in commands like `publish` and `sync`. It is recommended that you save this
+file at the root of your BYOSnap code and commit it to version control.
+
+```bash
+# Help for the byosnap command
+snapctl byosnap generate-profile --help
+
+# Generate your BYOSnap profile
+# $output_path = Directory where you want the BYOSnap profile to be saved.
+# $profile_filename = Name of the BYOSnap profile you want to give. Only .json, .yaml, .yml extensions
+#   are allowed. If you do not pass `--profile-filename` then Snapser choses
+#   `snapser-byosnap-profile.json` as the filename.
+snapctl byosnap generate-profile --out-path $output_path --profile-filename $profile_filename
+snapctl byosnap generate-profile --out-path /Users/DevName/Development/SnapserEngine/jinks_flask --profile-filename=my-byosnap-profile.json
+snapctl byosnap generate-profile --out-path /Users/DevName/Development/SnapserEngine/jinks_flask --profile-filename=my-byosnap-profile.yaml
+```
+
+### 3. byosnap validate-profile
+
+This command validates your BYOSnap profile.
+
+```bash
+# Help for the byosnap command
+snapctl byosnap validate-profile --help
+
+# Validate your BYOSnap profile
+# $path = Directory Path to where your BYOSnap Profile is located. No need to add the file name.
+# $resources_path = Optionally, you can place your BYOSnap profile at your resources path
+# $profile_filename = Optional parameter. Name of your BYOSnap profile.
+#   If you do not pass `--profile-filename` then
+#   Snapser choses the default `snapser-byosnap-profile.json` as the filename to validate
+snapctl byosnap validate-profile --path $path
+snapctl byosnap validate-profile --resources-path $resources_path --profile-filename $profile_filename
+snapctl byosnap validate-profile --path /Users/DevName/Development/SnapserEngine/jinks_flask
+snapctl byosnap validate-profile --path /Users/DevName/Development/SnapserEngine/jinks_flask --profile-filename my-byosnap-profile.yaml
+```
+
+#### 4. byosnap publish
 
 This command allows you to create and publish your BYOSnap. Running this command will first create a BYOSnap namespace on Snapser if not present. Then it will build and publish your code to your own
 private ECR repo on Snapser. Finally it will assign a version to your BYOSnap so that you
@@ -209,22 +312,26 @@ your BYOSnap like, name, description, etc and hardware requirements like CPU, Me
 recommend you store this file at the root of your BYOSnap and also add it to version control.
 You can generate it using `snapctl generate profile --category byosnap --out-path $outputPath`.
 
-```
+```bash
 # Help for the byosnap command
 snapctl byosnap publish --help
 
 # Create and publish your BYOSnap
-# $byosnap_sid = Snap ID for your snap
+# $byosnap_id = Snap ID for your snap
 # $version = Semantic version for your snap Eg: v0.0.1
 # $code_root_path = Local code path where your Dockerfile is present
 # $resources_path = Optional path to the resources directory in your Snap. This ensures, you are not forced to put the Dockerfile, snapser-byosnap-profile.json, swagger.json and README.md at the root directory of your Snap.
+# $profile_filename = Optional parameter. Name of your BYOSnap profile.
+#   If you do not pass `--profile-filename` then
+#   Snapser choses the default `snapser-byosnap-profile.json` as the filename to validate
 # $skip-build = true/false. Default is false. Pass this flag as true to skip the build and head straight to tag and push. Build step needs to run and tag using the --tag you pass to the publish-image command for this to work. Make sure the tag matches the version number you are passing.
 # Example:
-snapctl byosnap publish byosnap-jinks-flask --version "v0.0.1" --path /Users/DevName/Development/SnapserEngine/jinks_flask
-snapctl byosnap publish $byosnap_sid --version $version --path $code_root_path
+snapctl byosnap publish --byosnap-id byosnap-jinks-flask --version "v0.0.1" --path /Users/DevName/Development/SnapserEngine/jinks_flask --profile-filename $profile_filename
+snapctl byosnap publish --byosnap-id $byosnap_id --version $version --path $code_root_path
+byosnap publish --byosnap-id byosnap-python --version "v1.0.0" --path /Users/AJ/Development/byosnap-python --profile-filename my-byosnap-profile.yaml
 ```
 
-#### 3. byosnap sync
+#### 5. byosnap sync
 
 This command is for development purposes. It allows developers to rapidly build, update and push their BYOSnap to a dev Snapend. Simply, make changes to your code locally, and then run this command to deploy your BYOSnap straight to your development Snapend.
 
@@ -233,12 +340,12 @@ This command is for development purposes. It allows developers to rapidly build,
 
 **IMPORTANT**: This command will only work for Dev Snapends. Additionally if the version you are using in this command happens to be used by a staging or a production snapend then `sync` will not work. We do this to ensure that your staging and production BYOSnap images do not get impacted.
 
-```
+```bash
 # Help for the byosnap command
 snapctl byosnap sync --help
 
 # Deploy local code straight to your Snapend
-# $byosnap_sid = Snap ID for your snap
+# $byosnap_id = Snap ID for your snap
 # $code_root_path = Local code path where your Dockerfile is present
 # $resources_path = Optional path to the resources directory in your Snap. This ensures, you are not forced to put the Dockerfile, swagger.json and README.md in the root directory of your Snap.
 # $skip-build = true/false. Default is false. Pass this flag as true to skip the build and head straight to tag and push. Build step needs to run and tagged using the --tag you pass to the publish-image command for this to work.
@@ -246,84 +353,84 @@ snapctl byosnap sync --help
 # $version =
 # $snapend_id = Dev Snapend Id
 # Example:
-snapctl byosnap sync byosnap-jinks-flask --path /Users/DevName/Development/SnapserEngine/jinks_flask --version "v0.0.11" --snapend-id "jxmmfryo"
-snapctl byosnap sync $byosnap_sid --path $code_root_path --version $version --snapend-id $snapend_id
+snapctl byosnap sync --byosnap-id byosnap-jinks-flask --path /Users/DevName/Development/SnapserEngine/jinks_flask --version "v0.0.11" --snapend-id "jxmmfryo"
+snapctl byosnap sync --byosnap-id $byosnap_id --path $code_root_path --version $version --snapend-id $snapend_id
 ```
 
-#### 4. byosnap create
+#### 6. byosnap create
 
 Create a custom snap. Note that you will have to build, push and publish your snap image, for it to be useable
 in a Snapend.
 
-```
+```bash
 # Help for the byosnap command
 snapctl byosnap create --help
 
 # Create a new snap
-# $byosnap_sid = Snap ID for your snap. Start start with `byosnap-`
+# $byosnap_id = Snap ID for your snap. Start start with `byosnap-`
 # $name = User friendly name for your BYOSnap
 # $desc = User friendly description
 # $platform = One of linux/arm64, linux/amd64
 # $language = One of go, python, ruby, c#, c++, rust, java, node
 
 # Example:
-# snapctl byosnap create byosnap-jinks-flask --name "Jinks Flask Microservice" --desc "Custom Microservice" --platform "linux/arm64" --language "go"
-snapctl byosnap create $byosnap_sid --name "$name" --desc "$desc" --platform "$platform" --language "$language"
+# snapctl byosnap create --byosnap-id byosnap-jinks-flask --name "Jinks Flask Microservice" --desc "Custom Microservice" --platform "linux/arm64" --language "go"
+snapctl byosnap create --byosnap-id $byosnap_id --name "$name" --desc "$desc" --platform "$platform" --language "$language"
 ```
 
-#### 5. byosnap build
+#### 7. byosnap build
 
 Build your snap image
 
-```
+```bash
 # Help for the byosnap command
 snapctl byosnap build --help
 
 # Publish a new image
-# $byosnap_sid = Snap ID for your snap
+# $byosnap_id = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $code_root_path = Local code path where your Dockerfile is present
 # $resources_path = Optional path to the resources directory in your Snap. This ensures, you are not forced to put the Dockerfile, swagger.json and README.md in the root directory of your Snap.
 # Example:
-# snapctl byosnap build byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
-snapctl byosnap build $byosnap_sid --tag $image_tag --path $code_root_path
-snapctl byosnap build $byosnap_sid --tag $image_tag --path $code_root_path --resources-path $resources_path
+# snapctl byosnap build --byosnap-id byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
+snapctl byosnap build --byosnap-id $byosnap_id --tag $image_tag --path $code_root_path
+snapctl byosnap build --byosnap-id $byosnap_id --tag $image_tag --path $code_root_path --resources-path $resources_path
 ```
 
-#### 6. byosnap push
+#### 8. byosnap push
 
 Push your snap image to Snapser
 
-```
+```bash
 # Help for the byosnap command
 snapctl byosnap push --help
 
 # Publish a new image
-# $byosnap_sid = Snap ID for your snap
+# $byosnap_id = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # Example:
-# snapctl byosnap push byosnap-jinks-flask --tag my-first-image
-snapctl byosnap push $byosnap_sid --tag $image_tag
+# snapctl byosnap push --byosnap-id byosnap-jinks-flask --tag my-first-image
+snapctl byosnap push --byosnap-id $byosnap_id --tag $image_tag
 ```
 
-#### 7. byosnap upload-docs
+#### 9. byosnap upload-docs
 
 Upload swagger.json and README.md for you Snap
 
-```
+```bash
 # Help for the byosnap command
 snapctl byosnap upload-docs --help
 
 # Publish a new image
-# $byosnap_sid = Snap ID for your snap
+# $byosnap_id = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $resources_path = Path to your swagger.json and README.md files
 # Example:
-# snapctl byosnap upload-docs byosnap-jinks-flask --tag my-first-image --resources-path /Users/DevName/Development/SnapserEngine/jinks_flask
-snapctl byosnap upload-docs $byosnap_sid --tag $image_tag --resources-path $resources_path
+# snapctl byosnap upload-docs --byosnap-id byosnap-jinks-flask --tag my-first-image --resources-path /Users/DevName/Development/SnapserEngine/jinks_flask
+snapctl byosnap upload-docs --byosnap-id $byosnap_id --tag $image_tag --resources-path $resources_path
 ```
 
-#### 8. byosnap publish-image
+#### 10. byosnap publish-image
 
 Publish a custom snap code image. This command executes, `build`, `push` and `upload-docs` one
 after the other.
@@ -332,24 +439,24 @@ after the other.
 Commands in docker file may be hardware architecture specific. Snapser throws a warning if it detects
 a mismatch.
 
-```
+```bash
 # Help for the byosnap command
 snapctl byosnap publish-image --help
 
 # Publish a new image
-# $byosnap_sid = Snap ID for your snap
+# $byosnap_id = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $code_root_path = Local code path where your Dockerfile is present
 # $resources_path = Optional path to the resources directory in your Snap. This ensures, you are not forced to put the Dockerfile, swagger.json and README.md in the root directory of your Snap.
 # $skip-build = true/false. Default is false. Pass this flag as true to skip the build and head straight to tag and push. Build step needs to run and tagged using the --tag you pass to the publish-image command for this to work.
 # Example:
-# snapctl byosnap publish-image byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
-snapctl byosnap publish-image $byosnap_sid --tag $image_tag --path $code_root_path
-snapctl byosnap publish-image $byosnap_sid --tag $image_tag --path $code_root_path --resources-path $resources_path
-snapctl byosnap publish-image $byosnap_sid --tag $image_tag --skip-build
+# snapctl byosnap publish-image --byosnap-id byosnap-jinks-flask --tag my-first-image --path /Users/DevName/Development/SnapserEngine/jinks_flask
+snapctl byosnap publish-image --byosnap-id $byosnap_id --tag $image_tag --path $code_root_path
+snapctl byosnap publish-image --byosnap-id $byosnap_id --tag $image_tag --path $code_root_path --resources-path $resources_path
+snapctl byosnap publish-image --byosnap-id $byosnap_id --tag $image_tag --skip-build
 ```
 
-#### 9. byosnap publish-version
+#### 11. byosnap publish-version
 
 Publish a new version for your Snap. Only after your Snap version is published, you will be able
 to use your snap in your Snapend. This command should be run after `push` or `publish-image` commands.
@@ -357,18 +464,18 @@ to use your snap in your Snapend. This command should be run after `push` or `pu
 IMPORTANT: You need to have $byosnapProfile to run this command. BYOSnap profile is a JSON configuration
 of your BYOSnap for the development, staging and production environments. You can generate a base version of this file using the `snapctl generate profile --category byosnap --out-path <output_path>` command.
 
-```
+```bash
 # Help for the byosnap command
 snapctl byosnap publish-version --help
 
 # Publish a new image
-# $byosnap_sid = Snap ID for your snap
+# $byosnap_id = Snap ID for your snap
 # $image_tag = An image tag for your snap
 # $version = Semantic version for your snap Eg: v0.0.1
-# $byosnapProfilePath = Path to the snapser-byosnap-profile.json BYOSnap profile to configure dev, stage and prod settings for this snap. You can generate a base version of this file using the `snapctl generate profile --category byosnap --out-path <output_path>` command
+# $byosnap_profile_path = Path to the snapser-byosnap-profile.json BYOSnap profile to configure dev, stage and prod settings for this snap. You can generate a base version of this file using the `snapctl generate profile --category byosnap --out-path <output_path>` command
 # Example:
-# snapctl byosnap publish-version byosnap-jinks-flask --tag my-first-image --version v0.0.1 --path /Users/DevName/Development/SnapserEngine/jinks_flask
-snapctl byosnap publish-version $byosnap_sid --tag $image_tag --version $version --path $byosnapProfilePath
+# snapctl byosnap publish-version --byosnap-id byosnap-jinks-flask --tag my-first-image --version v0.0.1 --path /Users/DevName/Development/SnapserEngine/jinks_flask
+snapctl byosnap publish-version --byosnap-id $byosnap_id --tag $image_tag --version $version --path $byosnap_profile_path
 ```
 
 ### BYO Game Server - Bring your own Game Server
@@ -378,7 +485,7 @@ Snapctl commands for your custom game server
 
 See all the supported commands
 
-```
+```bash
 # Help for the byogs command
 snapctl byogs --help
 ```
@@ -387,7 +494,7 @@ snapctl byogs --help
 
 Build your custom game server image.
 
-```
+```bash
 # Help for the byogs command
 snapctl byogs build --help
 
@@ -403,7 +510,7 @@ snapctl byogs build --tag $image_tag --path $code_root_path
 
 Push your custom game server image.
 
-```
+```bash
 # Help for the byogs command
 snapctl byogs push --help
 
@@ -423,7 +530,7 @@ then publishing the byogs. Now all you have to do is publish your image and crea
 Commands in docker file may be hardware architecture specific. Snapser throws a warning if it detects
 a mismatch.
 
-```
+```bash
 # Help for the byogs command
 snapctl byogs publish --help
 
@@ -443,7 +550,7 @@ snapctl byogs publish --tag $image_tag --skip-build
 
 This command allows developers to rapidly build, update and push their BYOGs out to a Snapend fleet. Simply, make changes to your code locally, and then run this command to deploy your BYOGs straight to your Snapend fleet.
 
-```
+```bash
 # Help for the byogs command
 snapctl byogs sync --help
 
@@ -466,45 +573,37 @@ Snapctl commands for your game
 
 See all the supported commands
 
-```
+```bash
 # Help for the byogs command
 snapctl game --help
 ```
 
 #### 2. Create a game
 Create a game
-```
-snapctl game create --name $gameName
+```bash
+snapctl game create --name $game_name
 ```
 
 #### 3. Enumerate games
 List all the games
-```
+```bash
 snapctl game enumerate
 ```
 
 ### Generate
-Generator tool to help generate base files to be used in other commands
+Generator tool to help generate credentials
 
 #### 1. generate help
 See all the supported commands
-```
+```bash
 # Help for the generate command
 snapctl generate --help
 ```
 
-#### 2. Generate BYOSnap Profile
-Generate the base file for BYOSnap profile to be used in the `snapctl byosnap publish-version` command
-
-```
-snapctl generate profile --category "byosnap" --out-path $output_path
-
-```
-
-#### 3. Generate ECR Credentials
+#### 2. Generate ECR Credentials
 Generate the ECR credentials. Game studios can use these credentials to self publish their images to Snapser.
 
-```
+```bash
 snapctl generate credentials --category "ecr" --out-path $output_path
 
 ```
@@ -516,7 +615,7 @@ Snapctl commands for your snapend
 
 See all the supported commands
 
-```
+```bash
 # Help for the snapend command
 snapctl snapend --help
 ```
@@ -525,26 +624,27 @@ snapctl snapend --help
 
 Download Manifest, SDKs and Protos for your Snapend
 
-```
+```bash
 # Help for the download command
 snapctl snapend download --help
 
 # Download your Snapend SDK and Protos
 # $snapend_id = Cluster Id
-# $category = snapend-manifest, client-sdk, server-sdk, protos
-# $type = One of the supported types:
+# $category = snapend-manifest, sdk, protos
+# $format = One of the supported formats:
 #   snapend-manifest(yaml, json)
-#   client-sdk(unity, unreal, roblox, godot, cocos, ios-objc, ios-swift, android-java, android-kotlin, web-ts, web-js),
-#   server-sdk(csharp, cpp, lua, ts, go, python, kotlin, java, c, node, js, perl, php, closure, ruby, rust),
+#   sdk(unity, unreal, roblox, godot, cocos, ios-objc, ios-swift, android-java, android-kotlin, web-ts, web-js),
+#   sdk(csharp, cpp, lua, ts, go, python, kotlin, java, c, node, js, perl, php, closure, ruby, rust),
 #   protos(go, csharp, cpp, raw)
-# $protos-category = messages or services (only with --type protos)
-# $auth-type = user or app (only with --type server-sdk)
+# $type = One of the supported types:
+#   For --category=sdk --type(user, server, internal, app)
+#   For --category=protos --type(messages, services)
 # Example:
-# snapctl snapend download --snapend-id gx5x6bc0 --category snapend-manifest --type yaml --out-path .
-# snapctl snapend download --snapend-id gx5x6bc0 --category sdk --type unity --sdk-access-type external --sdk-auth-type user --out-path .
-# snapctl snapend download --snapend-id gx5x6bc0 --category sdk --type cpp --sdk-access-type internal --out-path .
-# snapctl snapend download --snapend-id gx5x6bc0 --category protos --type raw --protos-category messages --out-path .
-snapctl snapend download $snapend_id --category $category --type $type --sdk-access-type $sdk_access_type --sdk-auth-type $sdk_auth_type --out-path $out_path
+# snapctl snapend download --snapend-id gx5x6bc0 --category snapend-manifest --format yaml --out-path .
+# snapctl snapend download --snapend-id gx5x6bc0 --category sdk --format unity --type user --out-path .
+# snapctl snapend download --snapend-id gx5x6bc0 --category sdk --format cpp --type internal --out-path .
+# snapctl snapend download --snapend-id gx5x6bc0 --category protos --format raw --type messages --out-path .
+snapctl snapend download --snapend-id $snapend_id --category $category --format $format --type $type --out-path $out_path
 
 ```
 
@@ -552,19 +652,19 @@ snapctl snapend download $snapend_id --category $category --type $type --sdk-acc
 
 Clone a Snapend from an existing manifest. Passing the blocking flag ensures your CLI command waits till the new Snapend is up.
 
-```
+```bash
 # Help for the clone command
 snapctl snapend clone --help
 
 # Clone your Snapend
-# $gameId = Game Id
-# $snapendName = Name of your new Snapend
+# $game_id = Game Id
+# $snapend_name = Name of your new Snapend
 # $env = One of development, staging
-# $pathToManifest = Path to the manifest file; should include the file name
+# $path_to_manifest = Path to the manifest file; should include the file name
 # Example:
-# snapctl snapend clone --game-id 2581d802-aca-496c-8a76-1953ad0db165 --name new-snapend --env development --manifest-path "C:\Users\name\Downloads\snapser-ox1bcyim-manifest.json" --blocking
-snapctl snapend clone --game-id $gameId --name $snapendName --env $env --manifest-path "$pathToManifest"
-snapctl snapend clone --game-id $gameId --name $snapendName --env $env --manifest-path "$pathToManifest" --blocking
+# snapctl snapend clone --game-id 2581d802-aca-496c-8a76-1953ad0db165 --name new-snapend --env development --manifest-path-filename "C:\Users\name\Downloads\snapser-ox1bcyim-manifest.json" --blocking
+snapctl snapend clone --game-id $game_id --name $snapend_name --env $env --manifest-path-filename "$path_to_manifest"
+snapctl snapend clone --game-id $game_id --name $snapend_name --env $env --manifest-path-filename "$path_to_manifest" --blocking
 ```
 
 #### 4. Apply Snapend Changes
@@ -572,23 +672,23 @@ snapctl snapend clone --game-id $gameId --name $snapendName --env $env --manifes
 Apply changes to your Snapend from a manifest. You should have the latest manifest before applying changes. This is to prevent
 a user stomping over someone elses changes. Passing the blocking flag ensures your CLI command waits till the update is complete.
 
-```
+```bash
 # Help for the apply command
 snapctl snapend apply --help
 
 # Apply changes to a snapend via manifest
-# $pathToManifest = Path to the manifest file; should include the file name
+# $path_to_manifest = Path to the manifest file; should include the file name
 # Example:
-# snapctl snapend apply --manifest-path "C:\Users\name\Downloads\snapser-ox1bcyim-manifest.json" --blocking
-snapctl snapend apply --manifest-path "$pathToManifest"
-snapctl snapend apply --manifest-path "$pathToManifest" --blocking
+# snapctl snapend apply --manifest-path-filename "C:\Users\name\Downloads\snapser-ox1bcyim-manifest.json" --blocking
+snapctl snapend apply --manifest-path-filename "$path_to_manifest"
+snapctl snapend apply --manifest-path-filename "$path_to_manifest" --blocking
 ```
 
 #### 5. Update Snapend BYOSnap or BYOGs versions
 
 Update your BYOSnap or BYOGs versions for the Snapend
 
-```
+```bash
 # Help for the byogs command
 snapctl snapend update --help
 
@@ -608,7 +708,7 @@ snapctl snapend update --snapend-id $snapend_id --byosnaps $byosnaps --byogs $by
 
 Get the Snapend state
 
-```
+```bash
 # Help for the byogs command
 snapctl snapend state --help
 
@@ -671,6 +771,8 @@ snapctl snapend state $snapend_id
 | 46         | BYOSNAP update version service in use                    |
 | 47         | BYOSNAP update version tag error                         |
 | 48         | BYOSNAP update version invalid version error             |
+| 49         | BYOSNAP publish error                                    |
+| 86         | BYOSNAP generate-profile                                 |
 
 
 ### Game Errors
@@ -709,6 +811,5 @@ snapctl snapend state $snapend_id
 | Error Code | Description                                              |
 |------------|----------------------------------------------------------|
 | 80         | Generic generate error                                   |
-| 81         | Generate profile error                                   |
-| 82         | Generate credentials error                               |
+| 81         | Generate credentials error                               |
 

snapctl-0.46.0.dist-info/RECORD

@@ -0,0 +1,27 @@
+snapctl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+snapctl/__main__.py,sha256=43jKoTk8b85hk_MT6499N3ruHdEfM8WBImd_-3VzjI8,116
+snapctl/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+snapctl/commands/byogs.py,sha256=x-5QKvDWLj5hal8nH1mqd5r3G3EGwDB0BTP_SmFj-LQ,19025
+snapctl/commands/byosnap.py,sha256=xqlztM-C1Xo1l1asYCqTMr43bMFEFBkQ6Oct7yydMlo,72880
+snapctl/commands/game.py,sha256=nCXtEXAJkvOw26c_OBGr7Pz4hwu-5FXHyBR2kkXhLCM,5247
+snapctl/commands/generate.py,sha256=9-NlZVQllBT2LZT_t9S3ztwtHzTbM-C8_x0f6z70U3g,5606
+snapctl/commands/release_notes.py,sha256=K1OdX94pL-pKL2Depbs-AkVcPpKn_CX2cOsZiRZP5kc,2134
+snapctl/commands/snapend.py,sha256=pUpdJ5H-NSg-wB-NnMUXNvRL10ac8289-ZxPhCYMXEc,35570
+snapctl/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+snapctl/config/constants.py,sha256=r9NYFzPthNOc76uf70i6S8sehnI_tstQDftB_vxRDAE,3464
+snapctl/config/endpoints.py,sha256=9kllA79xn9G_aBLp1rohURZi93pwYzTEWZ8ObtZ6crw,338
+snapctl/config/hashes.py,sha256=MOn1R5zUQrVbgXT_SmGcRB_3LsQjxRpEiJtLoiIFBI8,4388
+snapctl/data/profiles/snapser-byosnap-profile.json,sha256=c7oIzMJewVQaoLaXCBPXlH-k5cL9DCz6q4IixsWWD9c,2404
+snapctl/data/profiles/snapser-byosnap-profile.yaml,sha256=vK5JqHa1f1_jlcW0m7qg-sKN9njE8PURJHzaRdvfEOY,3600
+snapctl/data/releases/beta-0.46.0.mdx,sha256=_MJA7TnnJjAnNm_EOvoBiz7FjHwl4c49sYtZ9r4KZQE,2386
+snapctl/main.py,sha256=3-0dyEk5pK9t9P4fahlrh5R2gBUlQEFM4CUhhC3SOl4,22237
+snapctl/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+snapctl/types/definitions.py,sha256=EQzLeiXkJ8ISRlCqHMviNVsWWpmhWjpKaOBLdlvOTmY,644
+snapctl/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+snapctl/utils/echo.py,sha256=V0qgjqqGXRiueMkq31enmNmdqciC8S90qGRcK8UupXA,1090
+snapctl/utils/helper.py,sha256=8HrLqX9RINJdadR7YI8epOXIfXOBDusXqvoR0kq6zok,5419
+snapctl-0.46.0.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
+snapctl-0.46.0.dist-info/METADATA,sha256=cNc5QjjGcC9hjIn8BysrPKZHD51FgL3A5ucwsP2Gov4,34343
+snapctl-0.46.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+snapctl-0.46.0.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
+snapctl-0.46.0.dist-info/RECORD,,

snapctl-0.44.1.dist-info/RECORD

@@ -1,23 +0,0 @@
-snapctl/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/__main__.py,sha256=43jKoTk8b85hk_MT6499N3ruHdEfM8WBImd_-3VzjI8,116
-snapctl/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/commands/byogs.py,sha256=jqX20rjgLg75E65Bx26TJpTDRQl2Eg6epFIZPXaJCbE,18989
-snapctl/commands/byosnap.py,sha256=VgZ34gnwt8j1Li2uVXym3XNT1qI9YiS5xkVIBnx9KD4,53706
-snapctl/commands/game.py,sha256=nCXtEXAJkvOw26c_OBGr7Pz4hwu-5FXHyBR2kkXhLCM,5247
-snapctl/commands/generate.py,sha256=isiTl3SE1G7wqEWjdYPKDtlBR-HE2-iNdZK_pKgiKvY,8398
-snapctl/commands/snapend.py,sha256=Zq9lNp1NO5fHzlv2S4TrzBZUIxssOu4_ZEQFMO2Tfbc,34677
-snapctl/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/config/constants.py,sha256=4kChgdr97xeUtLE80GPM1cP8ClZxn_EKMsZRgNq3pXA,3309
-snapctl/config/endpoints.py,sha256=9kllA79xn9G_aBLp1rohURZi93pwYzTEWZ8ObtZ6crw,338
-snapctl/config/hashes.py,sha256=sLk221XI8-fAfiIZ_sKmddcebL9yTCDIlhxQZNj4NA8,5729
-snapctl/main.py,sha256=DwndBr5-d18epV1PMzCINAargBMOblbXBTHsFsVZHXU,21463
-snapctl/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/types/definitions.py,sha256=EQzLeiXkJ8ISRlCqHMviNVsWWpmhWjpKaOBLdlvOTmY,644
-snapctl/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-snapctl/utils/echo.py,sha256=V0qgjqqGXRiueMkq31enmNmdqciC8S90qGRcK8UupXA,1090
-snapctl/utils/helper.py,sha256=8HrLqX9RINJdadR7YI8epOXIfXOBDusXqvoR0kq6zok,5419
-snapctl-0.44.1.dist-info/LICENSE,sha256=6AcXm54KFSpmUI1ji9NIBd4Xl-DtjTqiyjBzfVb_CEk,2804
-snapctl-0.44.1.dist-info/METADATA,sha256=QcNmOclG7_621_jHPOhaOZlx6H1d0JDzvy2ABEO1EW8,28866
-snapctl-0.44.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-snapctl-0.44.1.dist-info/entry_points.txt,sha256=tkKW9MzmFdRs6Bgkv29G78i9WEBK4WIOWunPfe3t2Wg,44
-snapctl-0.44.1.dist-info/RECORD,,