+
[](https://github.com/tauri-apps/tauri/tree/dev)
[](https://opencollective.com/tauri)
diff --git a/docs/api/cli.md b/docs/api/cli.md
deleted file mode 100644
index 21d8de872..000000000
--- a/docs/api/cli.md
+++ /dev/null
@@ -1,191 +0,0 @@
----
-id: cli
-title: CLI
----
-
-import Command from '@theme/Command'
-import Alert from '@theme/Alert'
-
-
-The tauri.js cli is composed in TypeScript and published as JavaScript.
-
-## `info`
-
-- -
- Values for arguments may be specified in any of the following methods:
-
`
- },
- { property: "index", type: "number", optional: true, description: `The positional argument index, starting at 1.
- -
-
- Using a space such as
-o valueor--option value
- - Using an equals and no space such as
-o=valueor--option=value
- - Use a short and no space such as
-ovalue
-
- The index refers to position according to other positional argument. It does not define position in the argument list as a whole.
- When utilized with multiple=true, only the last positional argument may be defined as multiple (i.e. the one with the highest index).
-
`
- },
- { property: "multiple", optional: true, type: "boolean", description: `Specifies that the argument may appear more than once.
- For flags, this results in the number of occurrences of the flag being recorded. For example -ddd or -d -d -d would count as three occurrences.
- For options, there is a distinct difference in multiple occurrences vs multiple values. For example, --opt val1 val2 is one occurrence, but two values. Whereas --opt val1 --opt val2 is two occurrences.` },
- { property: "possibleValues", optional: true, type: "string[]", description: `Specifies a list of possible values for this argument. At runtime, the CLI verifies that only one of the specified values was used, or fails with an error message.` },
- { property: "minValues", optional: true, type: "number", description: `Specifies the minimum number of values for this argument.
- For example, if you had a -f <file> argument where you wanted at least 2 "files" you would set minValues: 2, and this argument would be satisfied if the user provided, 2 or more values.` },
- { property: "maxValues", optional: true, type: "number", description: `Specifies the maximum number of values for this argument.
- For example, if you had a -f <file> argument where you wanted up to 3 "files" you would set max_values: 3, and this argument would be satisfied if the user provided, 1, 2, or 3 values.` },
- { property: "required", optional: true, type: "boolean", description: `Sets whether or not the argument is required by default.
- "required by default" means it is required, when no other conflicting rules have been evaluated
- conflicting rules take precedence over being required.` },
- { property: "requiredUnless", optional: true, type: "string", description: `Sets an arg that overrides this arg's required setting.- i.e. this arg will be required unless this other argument is present.` }, - { property: "requiredUnlessAll", optional: true, type: "string[]", description: `Sets args that override this arg's required setting.
- i.e. this arg will be required unless all these other arguments are present.` }, - { property: "requiredUnlessOne", optional: true, type: "string[]", description: `Sets args that override this arg's required setting.
- i.e. this arg will be required unless at least one of these other arguments are present.` }, - { property: "conflictsWith", optional: true, type: "string", description: `Sets a conflicting argument by name - i.e. when using this argument, the following argument can't be present and vice versa.` }, - { property: "conflictsWithAll", optional: true, type: "string", description: `The same as
"conflictsWith" but allows specifying multiple two-way conflicts per argument.` },
- { property: "requires", optional: true, type: "string", description: `Sets an argument by name that is required when this one is present.- i.e. when using this argument, the following argument must be present.` }, - { property: "requiresAll", optional: true, type: "string[]", description: `Sets multiple arguments by names that are required when this one is present.
- i.e. when using this argument, the following arguments must be present.` }, - { property: "requiresIf", optional: true, type: "[string, string]", description: `Allows a conditional requirement with the signature
[arg: string, value: string].
-
- The requirement will only become valid if
- ` },
- { property: "requiredIf", optional: true, type: "[string, string]", description: `Allows specifying that an argument is required conditionally with the signature "arg"'s value equals \${value}.
- [arg: string, value: string].
-
- The requirement will only become valid if the
- ` },
- { property: "requireEquals", optional: true, type: "boolean", description: `Requires that options use the "arg"'s value equals \${value}.
- --option=val syntax.- i.e. an equals between the option and associated value.` }, - ]} /> }, - { property: "description", optional: true, type: "string", description: `Command description which will be shown on the help information.` }, - { property: "longDescription", optional: true, type: "string", description: `Command long description which will be shown on the help information.` }, - { property: "beforeHelp", optional: true, type: "string", description: `Adds additional help information to be displayed in addition to auto-generated help.
- This information is displayed before the auto-generated help information.
- This is often used for header information.` }, - { property: "afterHelp", optional: true, type: "string", description: `Adds additional help information to be displayed in addition to auto-generated help.
- This information is displayed after the auto-generated help information.
- This is often used to describe how to use the arguments, or caveats to be noted.` }, - { property: "subcommands", optional: true, type: "{ [name: string]: CliConfig }", description: `List of subcommands of this command.
- Subcommands are effectively sub-apps, because they can contain their own arguments, subcommands, usage, etc.
- They also function just like the app command, in that they get their own auto generated help and usage.` }, - ]} /> - }, - { - property: "bundle", type: "object", - child:
- Note that Tauri will look for system-specific binaries following the pattern "binary-name{-target-triple}{.system-extension}".
- E.g. you typed "my-binary": -
` },
- { property: "copyright", optional: true, type: "string", description: `A copyright string associated with your application.` },
- { property: "category", optional: true, type: "string", description: `What kind of application this is.
- Should be one among the following list: - E.g. you typed "my-binary": -
-
-
- "my-binary-x86_64-pc-windows-msvc.exe" for Windows -
- "my-binary-x86_64-apple-darwin" for macOS -
- "my-binary-x86_64-unknown-linux-gnu" for Linux -
- Business, DeveloperTool, Education, Entertainment, Finance, Game, ActionGame, AdventureGame, ArcadeGame, BoardGame, CardGame, CasinoGame, DiceGame, EducationalGame, FamilyGame, KidsGame, MusicGame, PuzzleGame, RacingGame, RolePlayingGame, SimulationGame, SportsGame, StrategyGame, TriviaGame, WordGame, GraphicsAndDesign, HealthcareAndFitness, Lifestyle, Medical, Music, News, Photography, Productivity, Reference, SocialNetworking, Sports, Travel, Utility, Video, Weather. - ` }, - { property: "shortDescription", optional: true, type: "string", description: `A short description of your application.` }, - { property: "longDescription", optional: true, type: "string", description: `A longer, multi-line description of the application.` }, - { property: "deb", optional: true, type: "object", child:
- It should be a lowercase, without port and protocol domain name.
-
- ` },
- { property: "signingIdentity", optional: true, type: "string", description: `Identity to use for code signing.` },
- { property: "entitlements", optional: true, type: "string", description: `Path to the entitlements file.` },
- ]} /> },
- ]} />
- },
- {
- property: "allowlist", type: "object",
- child:
-
-
-## Description
-
-The Bridge recipe is a secure pattern where messages are passed between brokers via an implicit bridge using the API. It isolates functionality to scope and passes messages instead of functionality.
-
-## Diagram
-
-import Mermaid, { colors } from '@theme/Mermaid'
-
-
-
-
-
- | Ease of Use | -|
| Extensibility | -|
| Performance | -|
| Security | -
- })
-
-
-
- Pros:
-
--
-
- Highly configurable -
- No Rust skills required -
-
-
- Some WebAPIs unavailable -
- Challenge to implement -
-
-
-## Description
-
-The Cloudbridge recipe combines the flexibility of a localhost and the security of the bridge. With so many features, it can be easy to get lost.
-
-## Diagram
-
-import Mermaid, { colors } from '@theme/Mermaid'
-
-
-
-
-
- | Ease of Use | -|
| Extensibility | -|
| Performance | -|
| Security | -
- })
-
-
-
- Pros:
-
--
-
- All available features -
- No Rust skills required -
-
-
- Largest bundle size -
- Hard to separate concerns -
-
-
-## Description
-
-The Cloudish recipe is a pattern for maximum flexibility and app performance. It uses a localhost server, which means that your app will technically be available to other processes, like browsers and potentially other devices on the network. All of your assets are baked into the binary, but served as if they were distinct files.
-
-## Diagram
-
-import Mermaid, { colors } from '@theme/Mermaid'
-
-
-
-
-
- | Ease of Use | -|
| Extensibility | -|
| Performance | -|
| Security | -
- })
-
-
-
- Pros:
-
--
-
- Similar to a SPA web-app -
- No Rust skills required -
-
-
- No access to Rust API -
- Uses a localhost server -
-
-
-## Description
-
-The GLUI is a research pattern that we will use internally to test approaches using a GLUTIN window. We’re not sure yet if it will make the final cut as a bona fide alternative to WebView, although early tests with transparent and multiwindow are exciting.
-
-## Diagram
-
-import Mermaid, { colors } from '@theme/Mermaid'
-
-
-
-
-
- | Ease of Use | -|
| Extensibility | -|
| Performance | -|
| Security | -
- })
-
-
-
- Pros:
-
--
-
- Framebuffer FTW -
- Window events rigged -
-
-
- Broken on your machine -
-
-
-## Description
-
-The Hermit recipe is a pattern for ultimate application isolation where all logic is self-contained in the Window and the binary exists merely to bootstrap the Window. There is no communication back to Rust from the Window, there is no localhost server, and the Window has no access to any remote resources. The Hermit is great for interactive Kiosk Mode and standalone HTML based games.
-
-## Diagram
-
-import Mermaid, { colors } from '@theme/Mermaid'
-
-
-
-
-
- | Ease of Use | -|
| Extensibility | -|
| Performance | -|
| Security | -
- })
-
-
-
- Pros:
-
--
-
- Quick to make -
- Smallest size -
-
-
- No remote resources -
- No access to API -
-
-
-
-## Description
-
-The Lockdown recipe is a minimal usage of the [Bridge pattern](/docs/guides/patterns/bridge), which only allows interaction between Rust and the Window via expiring JS Promise Closures that are injected into the Window by Rust and nulled as part of the callback.
-
-## Diagram
-
-import Mermaid, { colors } from '@theme/Mermaid'
-
-
-
-
-
- | Ease of Use | -|
| Extensibility | -|
| Performance | -|
| Security | -
- })
-
-
-
- Pros:
-
--
-
- Highest security rating -
- Elegant and powerful -
-
-
- Rust skills required -
- No remote resources -
-
-
-## Description
-
-The Multiwin recipe will allow you to have multiple windows.
-
-## Diagram
-
-import Mermaid, { colors } from '@theme/Mermaid'
-
-
-
-
-
- | Ease of Use | -|
| Extensibility | -|
| Performance | -|
| Security | -
- })
-
-
-
- Pros:
-
--
-
- Windows can be spawned or destroyed at runtime -
- Separation of concerns -
-
-
- Somewhat complex -
Click me if you want to see how to set a project up from scratch
- -If you wanted to install the dependencies from scratch, just run the following command. - -Hello, Tauri!
- - -``` - -## Adding Tauri to the Cargo Project - -Next, we will add some necessary items to make our Cargo project into a Tauri project. First, is adding the dependencies -to the Cargo Manifest (`Cargo.toml`) so that Cargo knows to pull in our dependencies while building. - -`Cargo.toml`: - -```toml -[package] -name = "hello-tauri-webdriver" -version = "0.1.0" -edition = "2021" -rust-version = "1.56" - -# Needed to set up some things for Tauri at build time -[build-dependencies] -tauri-build = "1.0.0-beta.4" - -# The actual Tauri dependency, along with `custom-protocol` to serve the pages. -[dependencies] -tauri = { version = "1.0.0-beta.6", features = ["custom-protocol"] } - -# Make --release build a binary that is small (opt-level = "s") and fast (lto = true). -# This is completely optional, but shows that testing the application as close to the -# typical release settings is possible. Note: this will slow down compilation. -[profile.release] -incremental = false -codegen-units = 1 -panic = "abort" -opt-level = "s" -lto = true -``` - -As you may have noticed, we added a `[build-dependency]`. To use the build dependency, we must use it from a build -script. We will create one now at `build.rs`. - -`build.rs`: - -```rust -fn main() { - // Only watch the `dist/` directory for recompiling, preventing unnecessary - // changes when we change files in other project subdirectories. - println!("cargo:rerun-if-changed=dist"); - - // Run the Tauri build-time helpers - tauri_build::build() -} -``` - -With all that setup, our Cargo Project now knows how to pull in and build our Tauri dependencies. Let's finish making -this minimal example a Tauri application by setting up Tauri in the actual project code. We will be editing -the `src/main.rs` -file to add this Tauri functionality. - -`src/main.rs`: - -```rust -fn main() { - tauri::Builder::default() - .run(tauri::generate_context!()) - .expect("unable to run Tauri application"); -} -``` - -Pretty simple, right? - -## Tauri Configuration - -We are going to need 2 things to successfully build the application. First, we need an icon file. You can use any PNG -for this next part and copy it into `icon.png`. Typically, this will be provided as part of the scaffolding when you use -the Tauri CLI to create a project. To get the default Tauri icon, we can download the icon used by the Hello Tauri -example repository with the -command `curl -L "https://github.com/chippers/hello_tauri/raw/main/icon.png" --output icon.png`. - -The second thing we will need is a `tauri.conf.json` to specify some important configuration values to Tauri. Again, -this would typically come from the `tauri init` scaffolding command, but we will be creating our own minimal config -here. - -`tauri.conf.json`: - -```json -{ - "build": { - "distDir": "dist" - }, - "tauri": { - "bundle": { - "identifier": "studio.tauri.hello_tauri_webdriver", - "icon": [ - "icon.png" - ] - }, - "allowlist": { - "all": false - }, - "windows": [ - { - "width": 800, - "height": 600, - "resizable": true, - "fullscreen": false - } - ] - } -} -``` - -I'll go over some of these. You can see the `dist/` directory we created earlier specified as the `distDir` property. We -set a bundle identifier so that the built application has a unique id, along with setting the `icon.png` as the only -icon. We aren't using any Tauri apis or features, so we just disable all them in `allowlist` by setting `"all": false`. -The window values just sets a single window to be created with some reasonable default values. - -At this point, we have a basic Hello World application that when ran, should display a simple greeting. - -## Running the Example Application - -To make sure we did it right, let's build this application! We will run this as a `--release` application because we -will also run our WebDriver tests with a release profile. Run `cargo run --release` and after some compiling we should -see the following application pop up. - -
- 
-
-
-_Note: If you are modifying the application and want to use the Devtools, then run it without `--release` and "Inspect
-Element" should be available in the right click menu._
-
-We should now be ready to start testing this application with some WebDriver frameworks. This guide will go over both
-[WebdriverIO](webdriverio) and [Selenium](selenium) in that order.
\ No newline at end of file
diff --git a/docs/guides/webdriver/example/webdriverio.md b/docs/guides/webdriver/example/webdriverio.md
deleted file mode 100644
index 3571f3baf..000000000
--- a/docs/guides/webdriver/example/webdriverio.md
+++ /dev/null
@@ -1,276 +0,0 @@
----
-title: WebdriverIO
----
-import Alert from '@theme/Alert'
-import Tabs from '@theme/Tabs'
-import TabItem from '@theme/TabItem'
-
-Click me if you want to see how to set a project up from scratch
- -The CLI is interactive, and you may choose the tools to work with yourself. Note that you will likely diverge from -the rest of the guide, and need to set up the differences yourself. - -Let's add the [WebdriverIO] CLI to this npm project. - -
-
-```
-
-Note that you may need to move the rest of your content down so that the titlebar doesn't cover it.
-
-### JS
-
-Finally, you'll need to make the buttons work:
-
-
-```js
-import { appWindow } from '@tauri-apps/api/window'
-document
- .getElementById('titlebar-minimize')
- .addEventListener('click', () => appWindow.minimize())
-document
- .getElementById('titlebar-maximize')
- .addEventListener('click', () => appWindow.toggleMaximize())
-document
- .getElementById('titlebar-close')
- .addEventListener('click', () => appWindow.close())
-```
diff --git a/docs/sidebar.json b/docs/sidebar.json
deleted file mode 100644
index 8352432f2..000000000
--- a/docs/sidebar.json
+++ /dev/null
@@ -1,110 +0,0 @@
-[
- {
- "label": "Get started",
- "type": "category",
- "items": [
- "get-started/intro",
- "get-started/setup-linux",
- "get-started/setup-macos",
- "get-started/setup-windows"
- ]
- },
- {
- "label": "Development",
- "type": "category",
- "items": [
- "development/intro",
- "development/integration",
- "development/development",
- "development/debugging",
- "development/ci-cd",
- "development/cross-platform",
- "development/publishing",
- "development/updating"
- ]
- },
- {
- "label": "Guides",
- "type": "category",
- "items": [
- {
- "label": "Patterns",
- "type": "category",
- "items": [
- "guides/patterns/about-patterns",
- "guides/patterns/hermit",
- "guides/patterns/bridge",
- "guides/patterns/cloudish",
- "guides/patterns/cloudbridge",
- "guides/patterns/lockdown",
- "guides/patterns/multiwin",
- "guides/patterns/glui"
- ]
- },
- {
- "label": "Bundler",
- "type": "category",
- "items": [
- "guides/bundler/introduction",
- "guides/bundler/anti-bloat",
- "guides/bundler/sidecar",
- "guides/bundler/debian",
- "guides/bundler/sign-macos",
- "guides/bundler/sign-windows"
- ]
- },
- "guides/cli",
- "guides/command",
- "guides/events",
- "guides/plugin",
- "guides/updater",
- "guides/icons",
- "guides/splashscreen",
- "guides/window-customization",
- "guides/menu",
- "guides/system-tray",
- {
- "label": "WebDriver Testing",
- "type": "category",
- "items": [
- "guides/webdriver/introduction",
- {
- "label": "Example Application",
- "type": "category",
- "items": [
- "guides/webdriver/example/setup",
- "guides/webdriver/example/webdriverio",
- "guides/webdriver/example/selenium"
- ]
- },
- "guides/webdriver/ci"
- ]
- },
- "guides/migration",
- "guides/contributor-guide"
- ]
- },
- {
- "label": "Tips",
- "type": "category",
- "items": []
- },
- {
- "label": "API",
- "type": "category",
- "items": [
- "api/config",
- "api/cli",
- {
- "label": "Rust",
- "type": "category",
- "items": []
- },
- {
- "label": "JavaScript",
- "type": "category",
- "items": []
- }
- ]
- }
-]
- 
-
-
-
- 
-
-
-
- 
-
-
-