ip-tools 0.2.0

A CLI tool and library to retrieve the local IP address and list network interfaces
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

# ip-tools

[![Crates.io](https://img.shields.io/crates/v/ip-tools.svg)](https://crates.io/crates/ip-tools)
[![Docs.rs](https://docs.rs/ip-tools/badge.svg)](https://docs.rs/ip-tools)
[![CI](https://github.com/pplmx/ip-tools/workflows/CI/badge.svg)](https://github.com/pplmx/ip-tools/actions)
[![Coverage Status](https://coveralls.io/repos/github/pplmx/ip-tools/badge.svg?branch=main)](https://coveralls.io/github/pplmx/ip-tools?branch=main)
[![Rust GitHub Template](https://img.shields.io/badge/Rust%20GitHub-Template-blue)](https://rust-github.github.io/)

A small CLI tool to list network interfaces and retrieve the local IP address.

## Installation

### Cargo

* Install the rust toolchain in order to have cargo installed by following
  [this](https://www.rust-lang.org/tools/install) guide.
* run `cargo install ip-tools`

## Usage

### Get the local IP address

```shell
ip-tools get
```

Example output:

```
192.168.1.100
```

### List all network interfaces

```shell
ip-tools list
```

Example output:

```
lo: 127.0.0.1
eth0: 192.168.1.100
wlan0: 10.0.0.5
```

### JSON output

Pass `--json` for machine-readable output (useful for scripting and automation):

```shell
ip-tools get --json
ip-tools list --json
```

Example output for `get --json`:

```json
{"ip":"192.168.1.100"}
```

Example output for `list --json`:

```json
[{"name":"lo","ip":"127.0.0.1"},{"name":"eth0","ip":"192.168.1.100"}]
```

### Show help

```shell
ip-tools --help
```

## Library usage

`ip-tools` is also published as a library crate (`ip_tools`). See the
[API documentation](https://docs.rs/ip-tools) for details.

```rust
use ip_tools::{get_local_ip, list_net_ifs};

// Retrieve the local IP address
if let Ok(ip) = get_local_ip() {
    println!("local IP: {ip}");
}

// List all network interfaces
if let Ok(interfaces) = list_net_ifs() {
    for (name, ip) in &interfaces {
        println!("{name}: {ip}");
    }
}
```

A runnable example is provided in [`examples/ip_info.rs`](examples/ip_info.rs):

```shell
cargo run --example ip_info
```

## License

Licensed under either of

 * Apache License, Version 2.0
   ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
 * MIT license
   ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

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.

See [CONTRIBUTING.md](CONTRIBUTING.md).