[go: up one dir, main page]

whoami 1.0.0

Retrieve the current user and environment.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

![WhoAmI Logo](https://libcala.github.io/whoami/res/icon.svg)

#### WhoAmI

[![tests](https://github.com/libcala/whoami/workflows/tests/badge.svg)][2]
[![docs](https://docs.rs/whoami/badge.svg)][0]
[![crates.io](https://img.shields.io/crates/v/whoami.svg)][1]

[About][4] | [Source][5] | [Changelog][3]

Retrieve the current user and environment through simple functions.

Check out the [documentation][0] for examples.

### Features
 - Get the user's full name
 - Get the user's username
 - Get the devices's hostname
 - Get the devices's "pretty" or "fancy" name
 - Get the devices's desktop environment
 - Get the devices's OS name and version
 - Get the devices's platform name

### Supported Platforms
WhoAmI targets all platforms that can run Rust:
 - Linux
 - Windows
 - Mac OS
 - Web Assembly
 - Android and BSD (may partially or fully work, but untested) **planned next**
 - iOS / various game consoles **planned later**

## Binary
[whome](https://crates.io/crates/whome): `whoami` command RiR (Re-written in
Rust) that depends on this crate.

## License
Licensed under either of
 - Apache License, Version 2.0,
   ([LICENSE-APACHE][7] or [https://www.apache.org/licenses/LICENSE-2.0][8])
 - Zlib License,
   ([LICENSE-ZLIB][9] or [https://opensource.org/licenses/Zlib][10])
at your option.

### Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.

[0]: https://docs.rs/whoami
[1]: https://crates.io/crates/whoami
[2]: https://github.com/libcala/whoami/actions?query=workflow%3Atests
[3]: https://github.com/libcala/whoami/blob/master/CHANGELOG.md
[4]: https://libcala.github.io/whoami/
[5]: https://github.com/libcala/whoami/
[6]: https://aldaronlau.com/
[7]: https://github.com/libcala/whoami/blob/master/LICENSE-APACHE
[8]: https://www.apache.org/licenses/LICENSE-2.0
[9]: https://github.com/libcala/whoami/blob/master/LICENSE-ZLIB
[10]: https://opensource.org/licenses/Zlib