[bug] [tauri2-alpha.18] [NSIS] Looks like Tauri build muting --help clap command ?
#8305
Comments
Jimskapt
added
status: needs triage
|
If I were to guess, the problem lies in So when you run your application with cli flags from a command line, Windows know that this application is a GUI app and so it won't attach a console to it. How do you solve this problem? this problem only exists on Windows btw, Linux and macOS are fine so we need to only focus on Windows and re-attach a console to our app when we are passed an argument that requires printing to the console and here is an example of how to do so: Firstly, Add cargo add windows --features Win32_System_Console,Win32_Foundation --target 'cfg(windows)'Secondly, Add the following code at the beginning of your main function in #[cfg(windows)]
{
use windows::Win32::System::Console::{AttachConsole, ATTACH_PARENT_PROCESS};
// we ignore the result here because
// if the app started from a command line, like cmd or powershell,
// it will attach sucessfully which is what we want
// but if we were started from something like explorer,
// it will fail to attach console which is also what we want.
let _ = unsafe { AttachConsole(ATTACH_PARENT_PROCESS) };
}Now this is not the perfect solution because, your app is still marked as a GUI app and so cmd or powershell won't block the command line and wait for you to exit, instead it returns immediately and the use can the user can still execute other commands while your app is running and if the user presses So this is really only useful to print one time message and then either you exit your app, or de-attach the console using the following code. #[cfg(windows)]
{
use windows::Win32::System::Console::FreeConsole;
let _ = unsafe { FreeConsole() };
}And that might look like this: fn main() {
// this is just for demonstration purposes,
// there is better ways to parse args, or maybe use `clap` crate
if std::env::args_os().find(|a| a == "--help").is_some() {
#[cfg(windows)]
{
use windows::Win32::System::Console::{AttachConsole, ATTACH_PARENT_PROCESS, FreeConsole};
// we ignore the result here because
// if the app started from a command line, like cmd or powershell,
// it will attach sucessfully which is what we want
// but if we were started from something like explorer,
// it will fail to attach console which is also what we want.
let _ = unsafe { AttachConsole(ATTACH_PARENT_PROCESS) };
}
println!("help message");
std::process::exit(0);
// or if you want to keep your app going then just free the console
// #[cfg(windows)]
// {
// let _ = unsafe { FreeConsole() };
// }
}
tauri::Builder::default()
.run(tauri::generate_context!())
.expect("error while running tauri application");
}Now you might have a use-case where you want to keep a console window open, for maybe debugging or tracing and the user activates it by providing fn main() {
// this is just for demonstration purposes,
// there is better ways to parse args, or maybe use `clap` crate
#[cfg(windows)]
if std::env::args_os().find(|a| a == "--console").is_some() {
use windows::Win32::System::Console::AllocConsole;
let _ = unsafe { AllocConsole() };
}
tauri::Builder::default()
.run(tauri::generate_context!())
.expect("error while running tauri application");
}Another solution is to have two binaries:
and the purpose of the console binary is just a wrapper around the gui binary, and has 2 things to do:
|
|
Didn't mean to close the issue just yet. Does this works fine for you in [email protected] or just in 2.x? |
|
Hello @amrbashir and thank you for your answer ! 😊 I must confess that I've not yet tried your ideas about the bypassing of this GUI parameter. It looks like a pretty smart backup plan, thank you so much to explaining all of that ! 🍻
It's right because if I'm trying the build cli with another output command witch have to print to cli, like > C:\Users\[...]\AppData\Local\test-tauri2-clap\test-tauri2-clap.exe --version
>
I've tried to rebuild this project from scratch in the > cargo tauri dev
Error `tauri.conf.json` error on `tauri`: Additional properties are not allowed ('allowlist' was unexpected)Removing this part of the file, then : > cargo tauri dev
Info Watching C:\[...]\test-tauri2-clap\src-tauri for changes...
error: failed to select a version for `tauri`.
... required by package `test-tauri1-clap v0.0.0 (C:\[...]\test-tauri2-clap\src-tauri)`
versions that meet the requirements `^1.5` (locked to 1.5.3) are: 1.5.3
the package `test-tauri1-clap` depends on `tauri`, with features: `native-tls` but `tauri` does not have these features.
failed to select a version for `tauri` which could resolve this conflictSorry but I don't understand this errors so I can't answer you, yet 😣 |
|
I believe this issue exists in 1.5 as well so I will just close this since it is not really a bug and is intended behavior. |
Thank you very much for the method you described. It works pretty well on Windows. The only issue is, as you mentioned, the app attaches to the console but the parent shell process keeps running, which is strange. Is there any way to attach a Tauri app to the console (if CLI flags are detected) in a way that it won't return to the shell and works like a regular CLI app? |
|
I am not aware of a solution for that unfortunately, other than the two binaries workaround and that also has downsides. |
Describe the bug
Hello, looks like using
clapwith alpha version of Tauri 2.0.0 does not print--helpwhen it is compiled asnsispackage ?I'm not sure if it's an issue linked to
claportaurigears, but the fact it works well indevmode of tauri makes me contact you first.I'm on Windows 11 23H2 with rustc 1.74.0 (79e9716c9 2023-11-13)
Thank you for your help, tauri is still an amazing piece of technology ! 👍
Reproduction
You can use this repo as minimal reproduction :
https://github.com/Jimskapt/test-tauri2-clap
So, its works well in this
devmode.But then :
When i'm installing with
C:\[...]\test-tauri2-clap\src-tauri\target\release\bundle\nsis\test-tauri2-clap_0.1.0_x64-setup.exe, looks like this installed binary can't print--help(but it works well with--default-name dummyparameter, soclapis still here ?) :Expected behavior
Platform and versions
Stack trace
No response
Additional context
No response
The text was updated successfully, but these errors were encountered: