src/main.rs

@@ -38,6 +38,7 @@ enum Commands{
 	DownloadAndDecompileHistoryIntoGit(DownloadAndDecompileHistoryIntoGitSubcommand),
 }
 
+/// Download a range of assets from the asset version history.  Download summary is saved to `output_folder/versions.json`, and can be optionally used to download only new versions the next time.
 #[derive(Args)]
 struct DownloadHistorySubcommand{
 	#[arg(long)]
@@ -57,6 +58,7 @@ struct DownloadHistorySubcommand{
 	#[arg(long)]
 	end_version:Option<u64>,
 }
+/// Download a single asset by id.
 #[derive(Args)]
 struct DownloadSubcommand{
 	#[arg(long,group="cookie",required=true)]
@@ -70,6 +72,7 @@ struct DownloadSubcommand{
 	#[arg(required=true)]
 	asset_ids:Vec<AssetID>,
 }
+/// Download the list of asset ids (not the assets themselves) in a group inventory.  The output is written to `output_folder/versions.json`
 #[derive(Args)]
 struct DownloadGroupInventoryJsonSubcommand{
 	#[arg(long,group="cookie",required=true)]
@@ -83,6 +86,7 @@ struct DownloadGroupInventoryJsonSubcommand{
 	#[arg(long)]
 	group:u64,
 }
+/// Upload a (.rbxm, .rbxmx) model file, creating a new asset.  Can be any type of model, including modulescripts.
 #[derive(Args)]
 struct CreateAssetSubcommand{
 	#[arg(long,group="cookie",required=true)]
@@ -104,6 +108,7 @@ struct CreateAssetSubcommand{
 	#[arg(long)]
 	allow_comments:Option<bool>,
 }
+/// Upload a media file (.jpg, .png) to a new asset and print the asset id
 #[derive(Args)]
 struct CreateAssetMediaSubcommand{
 	#[arg(long,group="api_key",required=true)]
@@ -128,8 +133,8 @@ struct CreateAssetMediaSubcommand{
 	#[arg(long)]
 	expected_price:Option<u64>,
 }
+/// Upload multiple media files (.jpg, .png) Automatically detect the media type from file extension and generate asset name and description.  If you want support for more file types (.fbx, .mp3, .ogg) it should be fairly straightforward, just ask.
 #[derive(Args)]
-/// Automatically detect the media type from file extension and generate asset name and description
 struct CreateAssetMediasSubcommand{
 	#[arg(long,group="api_key",required=true)]
 	api_key_literal:Option<String>,
@@ -154,6 +159,7 @@ struct CreateAssetMediasSubcommand{
 	expected_price:Option<u64>,
 	input_files:Vec<PathBuf>,
 }
+/// Upload a (.rbxm, .rbxmx) model file to an existing asset.  Can be any type of model, including modulescripts.
 #[derive(Args)]
 struct UpdateAssetSubcommand{
 	#[arg(long)]
@@ -177,6 +183,7 @@ struct UpdateAssetSubcommand{
 	#[arg(long)]
 	change_allow_comments:Option<bool>,
 }
+/// Upload a media file (.jpg, .png) to an existing asset.
 #[derive(Args)]
 struct UpdateAssetMediaSubcommand{
 	#[arg(long)]
@@ -190,6 +197,7 @@ struct UpdateAssetMediaSubcommand{
 	#[arg(long)]
 	input_file:PathBuf,
 }
+/// Upload a place file (.rbxl, .rbxlx) to an existing place.
 #[derive(Args)]
 struct UpdatePlaceSubcommand{
 	#[arg(long)]
@@ -205,6 +213,7 @@ struct UpdatePlaceSubcommand{
 	#[arg(long)]
 	input_file:PathBuf,
 }
+/// Take an input folder containing scripts and models and turn it into a roblox file.  The two types of files (.rbxl: place, .rbxm: model) are actually the same file format, only the contents differ.
 #[derive(Args)]
 struct CompileSubcommand{
 	#[arg(long)]
@@ -216,6 +225,7 @@ struct CompileSubcommand{
 	#[arg(long)]
 	template:Option<PathBuf>,
 }
+/// Take an input folder containing scripts and models and turn it into a roblox file, then upload it to the specified asset id.  Does not work for places.
 #[derive(Args)]
 struct CompileUploadAssetSubcommand{
 	#[arg(long)]
@@ -235,6 +245,7 @@ struct CompileUploadAssetSubcommand{
 	#[arg(long)]
 	template:Option<PathBuf>,
 }
+/// Take an input folder containing scripts and models and turn it into a roblox file, then upload it to the specified place id.  Does not work for model asset ids.
 #[derive(Args)]
 struct CompileUploadPlaceSubcommand{
 	#[arg(long)]
@@ -254,6 +265,7 @@ struct CompileUploadPlaceSubcommand{
 	#[arg(long)]
 	template:Option<PathBuf>,
 }
+/// Take a roblox file (.rbxm, .rbxl) and turn it into a folder containing scripts and models.  Rox style means property overrides are written to the top of scripts, Rojo style means property overrides are written to the script file extension (Script.server.lua).
 #[derive(Args)]
 struct DecompileSubcommand{
 	#[arg(long)]
@@ -269,6 +281,7 @@ struct DecompileSubcommand{
 	#[arg(long)]
 	write_scripts:Option<bool>,
 }
+/// Download a model from the specified asset id, and decompile it into a folder in one swift motion.  The model file is not saved to disk.  This also works for places.
 #[derive(Args)]
 struct DownloadDecompileSubcommand{
 	#[arg(long,group="cookie",required=true)]
@@ -290,6 +303,7 @@ struct DownloadDecompileSubcommand{
 	#[arg(long)]
 	write_scripts:Option<bool>,
 }
+/// Take a folder of asset history (containing `versions.json`) and decompile each version into its own git commit.  This must be run with the desired output folder as the current directory due to git2 limitations.
 #[derive(Args)]
 struct DecompileHistoryIntoGitSubcommand{
 	#[arg(long)]
@@ -309,6 +323,7 @@ struct DecompileHistoryIntoGitSubcommand{
 	#[arg(long)]
 	write_scripts:Option<bool>,
 }
+/// Download asset history, download asset versions, decompile into folder, create a git commit for each version.  This is a combination of two commands (download-history, decompile-history-into-git) except without intermediate files.
 #[derive(Args)]
 struct DownloadAndDecompileHistoryIntoGitSubcommand{
 	#[arg(long)]