fwd/vendor/open/README.md
John Doty 9c435dc440 Vendor dependencies
Let's see how I like this workflow.
2022-12-19 08:38:22 -08:00

36 lines
1.1 KiB
Markdown

[![Crates.io](https://img.shields.io/crates/v/open.svg)](https://crates.io/crates/open)
[![cross-platform-testing](https://github.com/Byron/open-rs/workflows/cross-platform-testing/badge.svg)](https://github.com/Byron/open-rs/actions?query=workflow%3Across-platform-testing)
Use this library to open a path or URL using the program configured on the system. It is equivalent to running one of the following:
```bash
# macOS
$ open <path-or-url>
# Windows
$ start <path-or-url>
# Linux
$ xdg-open <path-or-url> || gio open <path-or-url> || gnome-open <path-or-url> || kde-open <path-or-url> || wslview <path-or-url>
```
# Usage
Add this to your Cargo.toml
```toml
[dependencies]
open = "3"
```
…and open something using…
```Rust
open::that("https://rust-lang.org");
```
…or, open something with an application of your choice
```Rust
open::with("https://rust-lang.org", "firefox");
```
Follow this link for the [massive API docs](https://docs.rs/open).
# Credits
The implementation is based on the respective functionality of [Cargo](https://github.com/rust-lang/cargo), but was improved to allow some error handling.