xtool 0.0.4

Amazing Tools
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
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

# xtool


A collection of amazing command-line tools, currently featuring a full-featured TFTP (Trivial File Transfer Protocol) implementation.

## Features


- **TFTP Server**: RFC-compliant TFTP server with support for read/write operations
- **TFTP Client**: Command-line client for downloading and uploading files
- **Protocol Extensions**: Supports blocksize, timeout, transfer size, and window size options
- **Single Port Mode**: Optional mode for NAT-friendly operations

## Installation


```bash
cargo install --path .
```

Or install from crates.io:

```bash
cargo install xtool
```

## Usage


### TFTP Server


Start a TFTP server:

```bash
# Basic usage - serve files from /var/tftp on port 69

xtool tftpd /var/tftp

# Specify IP and port

xtool tftpd -i 127.0.0.1 -p 6969 /path/to/directory

# Read-only mode

xtool tftpd -r /path/to/directory

# Single port mode (useful behind NAT)

xtool tftpd -s /path/to/directory
```

### TFTP Client


Download a file:

```bash
# Download file from server

xtool tftpc get 192.168.1.100 remote_file.txt

# Download to specific location

xtool tftpc get 192.168.1.100 remote_file.txt /path/to/local_file.txt

# Specify port and options

xtool tftpc get 192.168.1.100 remote_file.txt -p 6969 -b 8192 -t 10
```

Upload a file:

```bash
# Upload file to server

xtool tftpc put 192.168.1.100 local_file.txt

# Upload with different remote name

xtool tftpc put 192.168.1.100 local_file.txt remote_name.txt

# Specify options

xtool tftpc put 192.168.1.100 local_file.txt -p 6969 -b 8192 -t 10
```

### Serial Console


List available serial ports:

```bash
xtool serial list
```

Monitor a serial port (interactive shell):

```bash
# Monitor COM1 with default baud rate (115200)

xtool serial monitor COM1

# Monitor with specific baud rate

xtool serial monitor COM1 -b 9600

# Use configuration file defaults (if port is set in .xtool.toml)

xtool serial monitor
```

Key bindings:
- `Ctrl + ]`: Exit monitor mode

### Options


**Server Options:**
- `-i, --ip <IP>`: IP address to bind (default: 0.0.0.0)
- `-p, --port <PORT>`: Port to listen on (default: 69)
- `-r, --read-only`: Enable read-only mode (disable writes)
- `-s, --single-port`: Use single port mode

**Client Options:**
- `-p, --port <PORT>`: Server port (default: 69)
- `-b, --block-size <SIZE>`: Block size in bytes (default: 512, max: 65464)
- `-t, --timeout <SECONDS>`: Timeout in seconds (default: 5)

**Serial Options:**
- `-b, --baud <RATE>`: Baud rate (default: 115200)

## Examples


### Running Tests


```bash
# Run all tests

cargo test

# Run only integration tests

cargo test --test tftp_integration_test

# Run with output

cargo test -- --nocapture
```

### Example Session


Terminal 1 (Server):
```bash
$ xtool tftpd -p 6969 ./files
[14:20:00 INFO] Starting TFTP server on 0.0.0.0:6969
[14:20:00 INFO] Root directory: ./files
[14:20:00 INFO] TFTP server listening, press Ctrl+C to stop
```

Terminal 2 (Client):
```bash
$ xtool tftpc get 127.0.0.1 test.txt -p 6969
[14:20:15 INFO] Downloading test.txt from 127.0.0.1:6969
[14:20:15 INFO] Download completed successfully

$ xtool tftpc put 127.0.0.1 upload.txt -p 6969
[14:20:30 INFO] Uploading upload.txt to 127.0.0.1:6969
[14:20:30 INFO] Upload completed successfully
```

## License


Apache-2.0