{"id":13800644,"url":"https://github.com/tauri-apps/tauri-plugin-log","last_synced_at":"2025-04-05T08:07:24.054Z","repository":{"id":37075584,"uuid":"406471084","full_name":"tauri-apps/tauri-plugin-log","owner":"tauri-apps","description":"[READ ONLY] This repository is a mirror, for issue tracking and development head to: https://github.com/tauri-apps/plugins-workspace","archived":false,"fork":false,"pushed_at":"2024-10-08T07:30:29.000Z","size":1777,"stargazers_count":113,"open_issues_count":0,"forks_count":24,"subscribers_count":11,"default_branch":"v1","last_synced_at":"2024-10-29T15:44:12.542Z","etag":null,"topics":["logging","tauri-plugin"],"latest_commit_sha":null,"homepage":"https://github.com/tauri-apps/plugins-workspace","language":"Rust","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tauri-apps.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.spdx","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-14T17:58:12.000Z","updated_at":"2024-10-22T01:18:41.000Z","dependencies_parsed_at":"2023-12-25T13:09:22.301Z","dependency_job_id":"945e66d4-3194-41df-b649-cb72aa64e754","html_url":"https://github.com/tauri-apps/tauri-plugin-log","commit_stats":{"total_commits":31,"total_committers":7,"mean_commits":4.428571428571429,"dds":0.4838709677419355,"last_synced_commit":"cc86b2d9878d6ec02c9f25bd48292621a4bc2a6f"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tauri-apps%2Ftauri-plugin-log","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tauri-apps%2Ftauri-plugin-log/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tauri-apps%2Ftauri-plugin-log/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tauri-apps%2Ftauri-plugin-log/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tauri-apps","download_url":"https://codeload.github.com/tauri-apps/tauri-plugin-log/tar.gz/refs/heads/v1","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247305934,"owners_count":20917208,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["logging","tauri-plugin"],"created_at":"2024-08-04T00:01:14.679Z","updated_at":"2025-04-05T08:07:24.024Z","avatar_url":"https://github.com/tauri-apps.png","language":"Rust","readme":"![plugin-log](https://github.com/tauri-apps/plugins-workspace/raw/v1/plugins/log/banner.png)\n\nConfigurable logging for your Tauri app.\n\n## Install\n\n_This plugin requires a Rust version of at least **1.67**_\n\nThere are three general methods of installation that we can recommend.\n\n1. Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)\n2. Pull sources directly from Github using git tags / revision hashes (most secure)\n3. Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)\n\nInstall the Core plugin by adding the following to your `Cargo.toml` file:\n\n`src-tauri/Cargo.toml`\n\n```toml\n[dependencies]\ntauri-plugin-log = { git = \"https://github.com/tauri-apps/plugins-workspace\", branch = \"v1\" }\n```\n\nIf you want the single instance mechanism to only trigger for semver compatible instances of your apps, for example if you expect users to have multiple installations of your app installed, you can add `features = [\"semver\"]` to the dependency declaration in `Cargo.toml`.\n\nThen you can install the JavaScript Guest bindings using your preferred JavaScript package manager:\n\n\u003e Note: Since most JavaScript package managers are unable to install packages from git monorepos we provide read-only mirrors of each plugin. This makes installation option 2 more ergonomic to use.\n\n```sh\npnpm add https://github.com/tauri-apps/tauri-plugin-log#v1\n# or\nnpm add https://github.com/tauri-apps/tauri-plugin-log#v1\n# or\nyarn add https://github.com/tauri-apps/tauri-plugin-log#v1\n```\n\n## Usage\n\nFirst you need to register the core plugin with Tauri:\n\n`src-tauri/src/main.rs`\n\n```rust\nuse tauri_plugin_log::{LogTarget};\n\nfn main() {\n    tauri::Builder::default()\n        .plugin(tauri_plugin_log::Builder::default().targets([\n            LogTarget::LogDir,\n            LogTarget::Stdout,\n            LogTarget::Webview,\n        ]).build())\n        .run(tauri::generate_context!())\n        .expect(\"error while running tauri application\");\n}\n```\n\nAfterwards all the plugin's APIs are available through the JavaScript guest bindings:\n\n```javascript\nimport { trace, info, error, attachConsole } from \"tauri-plugin-log-api\";\n\n// with LogTarget::Webview enabled this function will print logs to the browser console\nconst detach = await attachConsole();\n\ntrace(\"Trace\");\ninfo(\"Info\");\nerror(\"Error\");\n\n// detach the browser console from the log stream\ndetach();\n```\n\nTo log from rust code, add the log crate to your `Cargo.toml`:\n\n```toml\n[dependencies]\nlog = \"^0.4\"\n```\n\nNow, you can use the macros provided by the log crate to log messages from your backend. See the [docs](https://docs.rs/log/latest) for more details.\n\n## Contributing\n\nPRs accepted. Please make sure to read the Contributing Guide before making a pull request.\n\n## Partners\n\n\u003ctable\u003e\n  \u003ctbody\u003e\n    \u003ctr\u003e\n      \u003ctd align=\"center\" valign=\"middle\"\u003e\n        \u003ca href=\"https://crabnebula.dev\" target=\"_blank\"\u003e\n          \u003cimg src=\"https://github.com/tauri-apps/plugins-workspace/raw/v1/.github/sponsors/crabnebula.svg\" alt=\"CrabNebula\" width=\"283\"\u003e\n        \u003c/a\u003e\n      \u003c/td\u003e\n    \u003c/tr\u003e\n  \u003c/tbody\u003e\n\u003c/table\u003e\n\nFor the complete list of sponsors please visit our [website](https://tauri.app#sponsors) and [Open Collective](https://opencollective.com/tauri).\n\n## License\n\nCode: (c) 2015 - Present - The Tauri Programme within The Commons Conservancy.\n\nMIT or MIT/Apache 2.0 where applicable.\n","funding_links":["https://opencollective.com/tauri"],"categories":["Development"],"sub_categories":["Plugins"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftauri-apps%2Ftauri-plugin-log","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftauri-apps%2Ftauri-plugin-log","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftauri-apps%2Ftauri-plugin-log/lists"}