Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mkashirin/filez
Filez is a very simple tool for receiving and sending files written in the Zig programming language.
https://github.com/mkashirin/filez
education systems-programming zig ziglang
Last synced: 2 months ago
JSON representation
Filez is a very simple tool for receiving and sending files written in the Zig programming language.
- Host: GitHub
- URL: https://github.com/mkashirin/filez
- Owner: mkashirin
- License: mit
- Created: 2024-03-17T21:31:39.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-08-24T18:26:26.000Z (5 months ago)
- Last Synced: 2024-08-24T19:38:58.255Z (5 months ago)
- Topics: education, systems-programming, zig, ziglang
- Language: Zig
- Homepage:
- Size: 85.9 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Filez
Filez is a very simple tool for receiving and sending files written in the Zig
programming language (version is 0.13.0) made to gain better understanding
of low level languages and systems programming in general.
## Building
At the moment, there is no direct method to download a binary for your system.
Therefore, if you wish to utilize this application, you will need to compile it
from source. Here are the steps to do so.
Clone this repository onto your local machine using the Git Command Line
Interface (CLI):
```bash
git clone https://github.com/mkashirin/filez
```
Compile a binary using the Zig compiler (the sole valid version of Zig
is 0.13.0) by running the following command:
```bash
zig build --release="safe"
```
After completing the above steps, the binary will be located in the
"zig-out/bin/" directory. That concludes the process. Consider different
`zig build` modes for embedded systems.
## Usage
The information provided by the `filez help` options describes
all the arguments in detail. However, the following is an example of how to use
the tool on your local machine only (make sure to make Filez visible to your
system first).
Open a terminal and execute the following command, specifying the path to the file
that you wish to process:
```bash
filez \
--action="dispatch" \
--fdpath="/absolute/path/to/file.ext" \
--host="127.0.0.1" \
--port="8080" \
--password="abcd1234"
```
Then, open a second terminal instance and execute the following command,
specifying your own path to the directory where you want to store the received file:
```bash
filez \
--action="receive" \
--fdpath="/absolute/path/to/directory/" \
--host="127.0.0.1" \
--port="8080" \
--password="abcd1234"
```
**Remember**, the file size must not exceed the maximum of 8 kilobytes.
## Note
Devises to be communicating with files must have ability to ping each other.