Upload - Tauri — ContextQMD

import PluginLinks from '@components/PluginLinks.astro'; import Compatibility from '@components/plugins/Compatibility.astro';

import { Tabs, TabItem, Steps } from '@astrojs/starlight/components'; import CommandTabs from '@components/CommandTabs.astro'; import PluginPermissions from '@components/PluginPermissions.astro';

Upload files from disk to a remote server over HTTP. Download files from a remote HTTP server to disk.

Supported Platforms

Setup

Use your project's package manager to add the dependency:

<CommandTabs
npm="npm run tauri add upload"
yarn="yarn run tauri add upload"
pnpm="pnpm tauri add upload"
deno="deno task tauri add upload"
bun="bun tauri add upload"
cargo="cargo tauri add upload"
/>

</TabItem>
<TabItem label="Manual">

	<Steps>

      1. Run the following command in the `src-tauri` folder to add the plugin to the project's dependencies in `Cargo.toml`:

          ```sh frame=none
          cargo add tauri-plugin-upload
          ```

      2. Modify `lib.rs` to initialize the plugin:

          ```rust title="src-tauri/src/lib.rs" ins={4}
          #[cfg_attr(mobile, tauri::mobile_entry_point)]
          pub fn run() {
            tauri::Builder::default()
              .plugin(tauri_plugin_upload::init())
                .run(tauri::generate_context!())
                .expect("error while running tauri application");
          }
          ```

      3. Install the JavaScript Guest bindings using your preferred JavaScript package manager:

          <CommandTabs
              npm="npm install @tauri-apps/plugin-upload"
              yarn="yarn add @tauri-apps/plugin-upload"
              pnpm="pnpm add @tauri-apps/plugin-upload"
              deno="deno add npm:@tauri-apps/plugin-upload"
              bun="bun add @tauri-apps/plugin-upload"
          />

	</Steps>
</TabItem>

</Tabs>

Usage

Once you've completed the registration and setup process for the plugin, you can access all of its APIs through the JavaScript guest bindings.

Here's an example of how you can use the plugin to upload and download files:

javascript

import { upload } from '@tauri-apps/plugin-upload';
// when using `"withGlobalTauri": true`, you may use
// const { upload } = window.__TAURI__.upload;

upload(
  'https://example.com/file-upload',
  './path/to/my/file.txt',
  ({ progress, total }) =>
    console.log(`Uploaded ${progress} of ${total} bytes`), // a callback that will be called with the upload progress
  { 'Content-Type': 'text/plain' } // optional headers to send with the request
);

javascript

import { download } from '@tauri-apps/plugin-upload';
// when using `"withGlobalTauri": true`, you may use
// const { download } = window.__TAURI__.upload;

download(
  'https://example.com/file-download-link',
  './path/to/save/my/file.txt',
  ({ progress, total }) =>
    console.log(`Downloaded ${progress} of ${total} bytes`), // a callback that will be called with the download progress
  { 'Content-Type': 'text/plain' } // optional headers to send with the request
);

Permissions

By default all potentially dangerous plugin commands and scopes are blocked and cannot be accessed. You must modify the permissions in your capabilities configuration to enable these.

See the Capabilities Overview for more information and the step by step guide to use plugin permissions.

json

{
  "permissions": [
    ...,
    "upload:default",
  ]
}