You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: assets/commands/airshare.md
+46-22Lines changed: 46 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,52 +4,76 @@ Share files between devices on the local network
4
4
5
5
# TLDR
6
6
7
-
**Share** a file
7
+
**Send** a file with a code
8
8
9
-
```airshare send [file.txt]```
9
+
```airshare [mycode] [file.txt]```
10
10
11
-
**Receive** files
11
+
**Receive** files using a code
12
12
13
-
```airshare receive [code]```
13
+
```airshare [mycode]```
14
14
15
-
Share multiple **files**
15
+
**Send** multiple files
16
16
17
-
```airshare send [file1.txt] [file2.txt]```
17
+
```airshare [mycode] [file1.txt] [file2.txt]```
18
18
19
-
Share a **directory**
19
+
**Send text** content directly
20
20
21
-
```airshare send [directory/]```
21
+
```airshare [mycode] -t "[Hello, World!]"```
22
+
23
+
**Host a receiving** (upload) server
24
+
25
+
```airshare [mycode] -u```
26
+
27
+
**Send clipboard** contents as text
28
+
29
+
```airshare [mycode] -cs```
30
+
31
+
**Specify a custom port**
32
+
33
+
```airshare [mycode] [file.txt] -p [9000]```
22
34
23
35
# SYNOPSIS
24
36
25
-
**airshare**_command_[_options_][_files_]
37
+
**airshare**[_options_]_code_[_files_]
26
38
27
39
# DESCRIPTION
28
40
29
-
**airshare** is a cross-platform file sharing tool that transfers files between devices on the same local network. It uses mDNS for device discovery and generates a simple code that recipients use to receive files.
41
+
**airshare** is a Python-based cross-platform file sharing tool that transfers files between devices on the same local network. It uses mDNS for device discovery and identifies transfers with a simple code word. Recipients access shared content by using the same code.
30
42
31
-
The tool provides a simple alternative to complex file sharing setups, requiring no server configuration or account creation.
43
+
The tool provides a simple alternative to complex file sharing setups, requiring no server configuration or account creation. Shared content can also be accessed via a web browser at `http://<code>.local:8000`.
32
44
33
45
# PARAMETERS
34
46
35
-
**send**_files_
36
-
> Share files or directories
47
+
_CODE_
48
+
> An identifying code word for the sharing session.
49
+
50
+
_FILES_
51
+
> File(s) or directories to send.
52
+
53
+
**-p**, **--port**_INTEGER_
54
+
> Specify the port number for the server (default: 8000).
55
+
56
+
**-t**, **--text**_TEXT_
57
+
> Send text content directly. Enclose multiple words in quotes.
58
+
59
+
**-u**, **--upload**
60
+
> Host a receiving server to accept uploaded files.
37
61
38
-
**receive**_code_
39
-
> Receive files using a share code
62
+
**-cs**, **--clip-send**
63
+
> Send clipboard contents as text.
40
64
41
-
**--no-zip**
42
-
> Don't compress multiple files
65
+
**-cr**, **--clip-receive**
66
+
> Receive content and copy it to the clipboard.
43
67
44
-
**--port**_port_
45
-
> Specify port number
68
+
**-fp**, **--file-path**
69
+
> Send files whose paths have been copied to the clipboard.
46
70
47
-
**--clipboard**
48
-
> Copy code to clipboard
71
+
**--version**
72
+
> Display version information.
49
73
50
74
# CAVEATS
51
75
52
-
Both devices must be on the same local network. Large files may take time to transfer depending on network speed. No encryption by default on older versions.
76
+
Both devices must be on the same local network. Large files are processed in chunks but may take time depending on network speed. The tool requires mDNS support on the network.
> Path to a SIF file or URI to a container image (docker://, library://, oci-archive://).
31
31
32
-
**--help**, **-h**
32
+
**--app**_string_
33
+
> Show the help for a specific app defined in the container rather than the general container help. The help text comes from the app's **%apphelp** section.
34
+
35
+
**-h**, **--help**
33
36
> Display help for the run-help command.
34
37
35
38
# DESCRIPTION
36
39
37
-
**apptainer run-help** displays help text embedded within an Apptainer/Singularity container. This help information is defined during container build time using the **%help** section in a definition file.
40
+
**apptainer run-help** displays help text embedded within an Apptainer/Singularity container. This help information is defined during container build time using the **%help** section in a definition file. When the **--app** flag is used, it displays help from the specified app's **%apphelp** section instead.
38
41
39
42
Container authors use the %help section to document how to use their container, including expected arguments, required bind mounts, environment variables, and example commands. This provides users with container-specific usage information without needing external documentation.
40
43
@@ -52,4 +55,4 @@ The run-help feature has been part of Singularity/Apptainer since early versions
**asciitoppm** converts ASCII text to a PPM (Portable Pixmap) color image. Each character in the input is mapped to a colored pixel, producing a visual representation of the text content.
18
22
19
-
Unlike **asciitopgm** which produces grayscale output, **asciitoppm** generates full-color images. The input is read from standard input and the output image dimensions must be specified. It is part of the Netpbm image processing toolkit.
23
+
Unlike **asciitopgm** which produces grayscale output, **asciitoppm** generates full-color images. The input is read from standard input and written to standard output. It is part of the Netpbm image processing toolkit.
20
24
21
25
# PARAMETERS
22
26
23
-
**width**
24
-
> Image width in pixels
25
-
26
-
**height**
27
-
> Image height in pixels
27
+
**-d**_colorfile_
28
+
> Use the specified color definition file to map characters to colors.
0 commit comments