chore(docs): Update Rust & TS docs

tauri-apps · Oct 17, 2023 · 56703bc · 56703bc
1 parent b3e6a45
commit 56703bc
Show file tree

Hide file tree

Showing 21 changed files with 943 additions and 4,390 deletions.
diff --git a/docs/api/cli.md b/docs/api/cli.md
@@ -70,15 +70,20 @@ Options:
 <Command name="plugin init" />
 
 ```
-Usage: cargo-tauri plugin init [OPTIONS] --name <PLUGIN_NAME>
+Usage: cargo-tauri plugin init [OPTIONS] [PLUGIN_NAME]
+
+Arguments:
+  [PLUGIN_NAME]  Name of your Tauri plugin. If not specified, it will be infered from the current directory
 
 Options:
-  -n, --name <PLUGIN_NAME>       Name of your Tauri plugin
+      --no-api                   Initializes a Tauri plugin without the TypeScript API
   -v, --verbose...               Enables verbose logging
-      --api                      Initializes a Tauri plugin with TypeScript API
   -d, --directory <DIRECTORY>    Set target directory for init [default: /home/runner/work/tauri-docs/tauri-docs]
   -t, --tauri-path <TAURI_PATH>  Path of the Tauri project to use (relative to the cwd)
   -a, --author <AUTHOR>          Author name
+      --android                  Whether to initialize an Android project for the plugin
+      --ios                      Whether to initialize an iOS project for the plugin
+      --mobile                   Whether to initialize Android and iOS projects for the plugin
   -h, --help                     Print help
   -V, --version                  Print version
 ```
@@ -91,21 +96,55 @@ Options:
 Usage: cargo-tauri dev [OPTIONS] [ARGS]...
 
 Arguments:
-  [ARGS]...  Command line arguments passed to the runner. Arguments after `--` are passed to the application
+  [ARGS]...
+          Command line arguments passed to the runner. Arguments after `--` are passed to the application
 
 Options:
-  -r, --runner <RUNNER>           Binary to use to run the application
-  -v, --verbose...                Enables verbose logging
-  -t, --target <TARGET>           Target triple to build against
-  -f, --features [<FEATURES>...]  List of cargo features to activate
-  -e, --exit-on-panic             Exit on panic
-  -c, --config <CONFIG>           JSON string or path to JSON file to merge with tauri.conf.json
-      --release                   Run the code in release mode
-      --no-watch                  Disable the file watcher
-      --no-dev-server             Disable the dev server for static files
-      --port <PORT>               Specify port for the dev server for static files. Defaults to 1430 Can also be set using `TAURI_DEV_SERVER_PORT` env var
-  -h, --help                      Print help
-  -V, --version                   Print version
+  -r, --runner <RUNNER>
+          Binary to use to run the application
+
+  -v, --verbose...
+          Enables verbose logging
+
+  -t, --target <TARGET>
+          Target triple to build against
+
+  -f, --features [<FEATURES>...]
+          List of cargo features to activate
+
+  -e, --exit-on-panic
+          Exit on panic
+
+  -c, --config <CONFIG>
+          JSON string or path to JSON file to merge with tauri.conf.json
+
+      --release
+          Run the code in release mode
+
+      --no-dev-server-wait
+          Skip waiting for the frontend dev server to start before building the tauri application
+          
+          [env: TAURI_CLI_NO_DEV_SERVER_WAIT=]
+
+      --no-watch
+          Disable the file watcher
+
+      --force-ip-prompt
+          Force prompting for an IP to use to connect to the dev server on mobile
+
+      --no-dev-server
+          Disable the built-in dev server for static files
+
+      --port <PORT>
+          Specify port for the built-in dev server for static files. Defaults to 1430
+          
+          [env: TAURI_CLI_PORT=]
+
+  -h, --help
+          Print help (see a summary with '-h')
+
+  -V, --version
+          Print version
 ```
 
 This command will open the WebView in development mode. It makes use of the `build.devPath` property from your `src-tauri/tauri.conf.json` file.
@@ -183,14 +222,15 @@ If you have entered a command to the `build.beforeBuildCommand` property, this o
 Usage: cargo-tauri icon [OPTIONS] [INPUT]
 
 Arguments:
-  [INPUT]  Path to the source icon (png, 1024x1024px with transparency) [default: ./app-icon.png]
+  [INPUT]  Path to the source icon (png, 1240x1240px with transparency) [default: ./app-icon.png]
 
 Options:
-  -o, --output <OUTPUT>  Output directory. Default: 'icons' directory next to the tauri.conf.json file
-  -v, --verbose...       Enables verbose logging
-  -p, --png <PNG>        Custom PNG icon sizes to generate. When set, the default icons are not generated
-  -h, --help             Print help
-  -V, --version          Print version
+  -o, --output <OUTPUT>        Output directory. Default: 'icons' directory next to the tauri.conf.json file
+  -v, --verbose...             Enables verbose logging
+  -p, --png <PNG>              Custom PNG icon sizes to generate. When set, the default icons are not generated
+      --ios-color <IOS_COLOR>  The background color of the iOS icon - string as defined in the W3C's CSS Color Module Level 4 <https://www.w3.org/TR/css-color-4/> [default: #fff]
+  -h, --help                   Print help
+  -V, --version                Print version
 ```
 
 For more information, check out the complete [Tauri Icon Guide](../guides/features/icons.md).