Skip to content

Docs/cli #1365

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Aug 9, 2023
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 71 additions & 0 deletions src/content/docs/2/guide/plugins/develop-plugin.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
---
title: Develop a Tauri Plugin
---

import Stub from '@components/Stub.astro';

<Stub />

## `plugin init`

```sh
cargo tauri plugin init
```

```
Initializes a Tauri plugin project

Usage: cargo tauri plugin init [OPTIONS] --name <PLUGIN_NAME>

Options:
-n, --name <PLUGIN_NAME> Name of your Tauri plugin
-v, --verbose... Enables verbose logging
--no-api Initializes a Tauri plugin without the TypeScript API
-d, --directory <DIRECTORY> Set target directory for init [default: C:\Users\Fabian-Lars]
-t, --tauri-path <TAURI_PATH> Path of the Tauri project to use (relative to the cwd)
-a, --author <AUTHOR> Author name
-h, --help Print help
-V, --version Print version
```

## `plugin android`

```sh
cargo tauri plugin android
```

```
Manage the Android project for Tauri plugins

Usage: cargo tauri plugin android [OPTIONS] <COMMAND>

Commands:
add Adds the Android project to an existing Tauri plugin
help Print this message or the help of the given subcommand(s)

Options:
-v, --verbose... Enables verbose logging
-h, --help Print help
-V, --version Print version
```

## `plugin ios`

```sh
cargo tauri plugin ios
```

```
Manage the iOS project for Tauri plugins

Usage: cargo tauri plugin ios [OPTIONS] <COMMAND>

Commands:
add Adds the iOS project to an existing Tauri plugin
help Print this message or the help of the given subcommand(s)

Options:
-v, --verbose... Enables verbose logging
-h, --help Print help
-V, --version Print version
```
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import Stub from '@components/Stub.astro';
<Stub>

- What is a Plugin?
- Developing a Plugin
- [Developing a Plugin](/2/guide/plugins/develop-plugin)
- Guide/Recipe for each plugin in https://github.com/tauri-apps/plugins-workspace/tree/v2

</Stub>
3 changes: 0 additions & 3 deletions src/content/docs/2/reference/cli.md

This file was deleted.

Loading