tauri-apps / tauri-apps/tauri-docs

Tauri CLI 2.0 DX Improvements

Open
#1,373 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement upstream
Dominant language
MDX
Stars
1.1k
Forks
887
Avg merge
2d 8h
Merged PRs (30d)
48

Description

Issues related to https://github.com/tauri-apps/tauri-docs/pull/1365

Could we adjust a few things in the Tauri CLI to improve the DX:

  • Add this (or similar) to help for dev:

This command will open the WebView in development mode. It makes use of the build.devPath property from your tauri.conf.json file.
If you have entered a command to the build.beforeDevCommand property, this one will be executed before the dev command.

  • Add this (or similar) to help for info:

tauri info shows a concise list of information about the environment, Rust, Node.js and their versions as well as a few relevant project configurations.

  • Add better copy for completions command:

The Tauri CLI can generate shell completions for Bash, Zsh, PowerShell and Fish.

Are there any instructions after running this command on how to actually make it kick into place? If so could we include those in either the help comments or log them out so the user isn't confused on why things aren't working? @FabianLars wrote some amazing things here that I think belongs in the CLI instead.

  • Switch tauri plugin add to tauri add

We've talked about this on a few places and I've not heard anything against this, but open to discussion if needed. Basically let's simplify this stuff as much as possible. End users don't care so much about if it's a plugin, they care about the functionality.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the referenced tauri-docs pull request 1365 and the CLI documentation in src/content/docs/2/reference/cli.mdx, especially lines 292-424. Compare that guidance with the requested dev, info, completions, and add command changes, then verify that the help text and completion setup instructions cover the listed user questions and all checklist items are addressed.

Written by the indexing model from the issue text.

Assessment

Tech stack
bash, fish, node.js, powershell, rust, zsh
Domain
cli, developer-experience, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.