@hiverra/portal 0.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Spectra
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,213 @@
1
+ # Portal
2
+
3
+ Portal started as a personal way to move files from phone to computer. It is now a CLI tool designed to make file transfers effortless.
4
+
5
+ ## Overview
6
+
7
+ Portal (Hiverra Portal) is a local-first file transfer tool built for simple, reliable sharing across devices. Today it focuses on CLI ↔ CLI transfers. Browser flows are planned.
8
+
9
+ ## What Portal Does (Today)
10
+
11
+ - **CLI ↔ CLI transfers** over local networks
12
+ - **Files and folders** (recursive sends supported)
13
+ - **Discovery mode** with identity verification
14
+ - **Direct IP mode** for quick sends
15
+ - **Transfer history** with export and cleanup
16
+ - **Optional no-compress** mode (tar only)
17
+
18
+ ## Planned
19
+
20
+ - **CLI ↔ Browser**
21
+ - **Browser ↔ CLI**
22
+
23
+ ## Who It’s For
24
+
25
+ Portal is for anyone who wants a fast, local, no-fuss way to move files between devices without relying on external services. It is ideal for personal workflows and small team transfers on the same network.
26
+
27
+ ## Install
28
+
29
+ **Release Installers (Recommended)**
30
+
31
+ **Shell script (Linux/macOS)**
32
+
33
+ ```bash
34
+ curl --proto '=https' --tlsv1.2 -LsSf https://github.com/Spectra010s/portal/releases/download/v0.9.0/hiverra-portal-installer.sh | sh
35
+ ```
36
+
37
+ **PowerShell (Windows)**
38
+
39
+ ```powershell
40
+ powershell -ExecutionPolicy Bypass -c "irm https://github.com/Spectra010s/portal/releases/download/v0.9.0/hiverra-portal-installer.ps1 | iex"
41
+ ```
42
+
43
+ **npm (prebuilt binaries)**
44
+
45
+ ```bash
46
+ npm install hiverra-portal@0.9.0
47
+ ```
48
+
49
+ **Android / Termux**
50
+
51
+ ```bash
52
+ curl -LsSf https://github.com/Spectra010s/portal/releases/download/v0.9.0/hiverra-portal-android-installer.sh | sh
53
+ ```
54
+
55
+ **Direct download**
56
+
57
+ - Download the release asset for your OS from GitHub Releases.
58
+
59
+ **Build From Source**
60
+
61
+ - Install Rust
62
+
63
+ ```bash
64
+ cargo build -p hiverra-portal
65
+ ```
66
+
67
+ ## Quick Start
68
+
69
+ 1. Run setup
70
+
71
+ ```bash
72
+ portal config setup
73
+ ```
74
+
75
+ 1. On receiver
76
+
77
+ ```bash
78
+ portal receive
79
+ ```
80
+
81
+ 1. On sender
82
+
83
+ ```bash
84
+ portal send path/to/file
85
+ ```
86
+
87
+ ## Usage Examples
88
+
89
+ **Start receiver**
90
+
91
+ ```bash
92
+ portal receive
93
+ ```
94
+
95
+ **Send via discovery**
96
+
97
+ ```bash
98
+ portal send --to <username> path/to/file
99
+ ```
100
+
101
+ **Send via direct IP**
102
+
103
+ ```bash
104
+ portal send --address <ip> --port <port> path/to/file
105
+ ```
106
+
107
+ **Send a folder (recursive)**
108
+
109
+ ```bash
110
+ portal send -r path/to/folder
111
+ ```
112
+
113
+ **No-compress**
114
+
115
+ ```bash
116
+ portal send --no-compress path/to/file
117
+ ```
118
+
119
+ **History (list + export)**
120
+
121
+ ```bash
122
+ portal history
123
+ portal history export --detailed --output portal_history.json
124
+ ```
125
+
126
+ **Update**
127
+ To update Portal:
128
+
129
+ ```bash
130
+ portal update
131
+ ```
132
+
133
+ ## How to Run or Use It
134
+
135
+ Portal is a command-line tool. Common commands:
136
+
137
+ **Send a file**
138
+ Use this to send a specific file. If no file is specified, Portal will prompt you to select one.
139
+
140
+ ```bash
141
+ portal send <file_path>
142
+ ```
143
+
144
+ **Send with discovery (recommended)**
145
+ Sends to a user by username and verifies identity.
146
+
147
+ ```bash
148
+ portal send --to <username> <file_path>
149
+ ```
150
+
151
+ **Send via direct IP**
152
+ Use this when you already know the receiver’s IP and port.
153
+
154
+ ```bash
155
+ portal send --address <IP_ADDRESS> --port <PORT> <file_path>
156
+ ```
157
+
158
+ **Receive**
159
+ Puts Portal into listening mode to receive files.
160
+
161
+ ```bash
162
+ portal receive
163
+ ```
164
+
165
+ **Receive on a custom port**
166
+
167
+ ```bash
168
+ portal receive --port <PORT>
169
+ ```
170
+
171
+ **Configuration setup**
172
+ Interactive setup to configure username and default port.
173
+
174
+ ```bash
175
+ portal config setup
176
+ ```
177
+
178
+ **Set a configuration value**
179
+
180
+ ```bash
181
+ portal config set <key> <value>
182
+ ```
183
+
184
+ **Show a configuration value**
185
+
186
+ ```bash
187
+ portal config show <key>
188
+ ```
189
+
190
+ **List current configuration**
191
+
192
+ ```bash
193
+ portal config list
194
+ ```
195
+
196
+ ## Documentation
197
+
198
+ - [docs/index.md](https://github.com/Spectra010s/portal/blob/main/docs/index.md)
199
+ - [docs/install.md](https://github.com/Spectra010s/portal/blob/main/docs/install.md)
200
+ - [docs/usage.md](https://github.com/Spectra010s/portal/blob/main/docs/usage.md)
201
+ - [docs/cli-cli.md](https://github.com/Spectra010s/portal/blob/main/docs/cli-cli.md)
202
+ - [docs/troubleshooting.md](https://github.com/Spectra010s/portal/blob/main/docs/troubleshooting.md)
203
+ - [docs/faq.md](https://github.com/Spectra010s/portal/blob/main/docs/faq.md)
204
+
205
+ ## Author
206
+
207
+ Spectra010s
208
+
209
+ ## License
210
+
211
+ [LICENSE](https://github.com/Spectra010s/portal/blob/main/LICENSE)
212
+
213
+ > Hiverra Portal: A lightweight CLI tool to transfer files between devices locally or remotely.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Spectra
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,213 @@
1
+ # Portal
2
+
3
+ Portal started as a personal way to move files from phone to computer. It is now a CLI tool designed to make file transfers effortless.
4
+
5
+ ## Overview
6
+
7
+ Portal (Hiverra Portal) is a local-first file transfer tool built for simple, reliable sharing across devices. Today it focuses on CLI ↔ CLI transfers. Browser flows are planned.
8
+
9
+ ## What Portal Does (Today)
10
+
11
+ - **CLI ↔ CLI transfers** over local networks
12
+ - **Files and folders** (recursive sends supported)
13
+ - **Discovery mode** with identity verification
14
+ - **Direct IP mode** for quick sends
15
+ - **Transfer history** with export and cleanup
16
+ - **Optional no-compress** mode (tar only)
17
+
18
+ ## Planned
19
+
20
+ - **CLI ↔ Browser**
21
+ - **Browser ↔ CLI**
22
+
23
+ ## Who It’s For
24
+
25
+ Portal is for anyone who wants a fast, local, no-fuss way to move files between devices without relying on external services. It is ideal for personal workflows and small team transfers on the same network.
26
+
27
+ ## Install
28
+
29
+ **Release Installers (Recommended)**
30
+
31
+ **Shell script (Linux/macOS)**
32
+
33
+ ```bash
34
+ curl --proto '=https' --tlsv1.2 -LsSf https://github.com/Spectra010s/portal/releases/download/v0.9.0/hiverra-portal-installer.sh | sh
35
+ ```
36
+
37
+ **PowerShell (Windows)**
38
+
39
+ ```powershell
40
+ powershell -ExecutionPolicy Bypass -c "irm https://github.com/Spectra010s/portal/releases/download/v0.9.0/hiverra-portal-installer.ps1 | iex"
41
+ ```
42
+
43
+ **npm (prebuilt binaries)**
44
+
45
+ ```bash
46
+ npm install hiverra-portal@0.9.0
47
+ ```
48
+
49
+ **Android / Termux**
50
+
51
+ ```bash
52
+ curl -LsSf https://github.com/Spectra010s/portal/releases/download/v0.9.0/hiverra-portal-android-installer.sh | sh
53
+ ```
54
+
55
+ **Direct download**
56
+
57
+ - Download the release asset for your OS from GitHub Releases.
58
+
59
+ **Build From Source**
60
+
61
+ - Install Rust
62
+
63
+ ```bash
64
+ cargo build -p hiverra-portal
65
+ ```
66
+
67
+ ## Quick Start
68
+
69
+ 1. Run setup
70
+
71
+ ```bash
72
+ portal config setup
73
+ ```
74
+
75
+ 1. On receiver
76
+
77
+ ```bash
78
+ portal receive
79
+ ```
80
+
81
+ 1. On sender
82
+
83
+ ```bash
84
+ portal send path/to/file
85
+ ```
86
+
87
+ ## Usage Examples
88
+
89
+ **Start receiver**
90
+
91
+ ```bash
92
+ portal receive
93
+ ```
94
+
95
+ **Send via discovery**
96
+
97
+ ```bash
98
+ portal send --to <username> path/to/file
99
+ ```
100
+
101
+ **Send via direct IP**
102
+
103
+ ```bash
104
+ portal send --address <ip> --port <port> path/to/file
105
+ ```
106
+
107
+ **Send a folder (recursive)**
108
+
109
+ ```bash
110
+ portal send -r path/to/folder
111
+ ```
112
+
113
+ **No-compress**
114
+
115
+ ```bash
116
+ portal send --no-compress path/to/file
117
+ ```
118
+
119
+ **History (list + export)**
120
+
121
+ ```bash
122
+ portal history
123
+ portal history export --detailed --output portal_history.json
124
+ ```
125
+
126
+ **Update**
127
+ To update Portal:
128
+
129
+ ```bash
130
+ portal update
131
+ ```
132
+
133
+ ## How to Run or Use It
134
+
135
+ Portal is a command-line tool. Common commands:
136
+
137
+ **Send a file**
138
+ Use this to send a specific file. If no file is specified, Portal will prompt you to select one.
139
+
140
+ ```bash
141
+ portal send <file_path>
142
+ ```
143
+
144
+ **Send with discovery (recommended)**
145
+ Sends to a user by username and verifies identity.
146
+
147
+ ```bash
148
+ portal send --to <username> <file_path>
149
+ ```
150
+
151
+ **Send via direct IP**
152
+ Use this when you already know the receiver’s IP and port.
153
+
154
+ ```bash
155
+ portal send --address <IP_ADDRESS> --port <PORT> <file_path>
156
+ ```
157
+
158
+ **Receive**
159
+ Puts Portal into listening mode to receive files.
160
+
161
+ ```bash
162
+ portal receive
163
+ ```
164
+
165
+ **Receive on a custom port**
166
+
167
+ ```bash
168
+ portal receive --port <PORT>
169
+ ```
170
+
171
+ **Configuration setup**
172
+ Interactive setup to configure username and default port.
173
+
174
+ ```bash
175
+ portal config setup
176
+ ```
177
+
178
+ **Set a configuration value**
179
+
180
+ ```bash
181
+ portal config set <key> <value>
182
+ ```
183
+
184
+ **Show a configuration value**
185
+
186
+ ```bash
187
+ portal config show <key>
188
+ ```
189
+
190
+ **List current configuration**
191
+
192
+ ```bash
193
+ portal config list
194
+ ```
195
+
196
+ ## Documentation
197
+
198
+ - [docs/index.md](https://github.com/Spectra010s/portal/blob/main/docs/index.md)
199
+ - [docs/install.md](https://github.com/Spectra010s/portal/blob/main/docs/install.md)
200
+ - [docs/usage.md](https://github.com/Spectra010s/portal/blob/main/docs/usage.md)
201
+ - [docs/cli-cli.md](https://github.com/Spectra010s/portal/blob/main/docs/cli-cli.md)
202
+ - [docs/troubleshooting.md](https://github.com/Spectra010s/portal/blob/main/docs/troubleshooting.md)
203
+ - [docs/faq.md](https://github.com/Spectra010s/portal/blob/main/docs/faq.md)
204
+
205
+ ## Author
206
+
207
+ Spectra010s
208
+
209
+ ## License
210
+
211
+ [LICENSE](https://github.com/Spectra010s/portal/blob/main/LICENSE)
212
+
213
+ > Hiverra Portal: A lightweight CLI tool to transfer files between devices locally or remotely.
Binary file
Binary file
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Spectra
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,213 @@
1
+ # Portal
2
+
3
+ Portal started as a personal way to move files from phone to computer. It is now a CLI tool designed to make file transfers effortless.
4
+
5
+ ## Overview
6
+
7
+ Portal (Hiverra Portal) is a local-first file transfer tool built for simple, reliable sharing across devices. Today it focuses on CLI ↔ CLI transfers. Browser flows are planned.
8
+
9
+ ## What Portal Does (Today)
10
+
11
+ - **CLI ↔ CLI transfers** over local networks
12
+ - **Files and folders** (recursive sends supported)
13
+ - **Discovery mode** with identity verification
14
+ - **Direct IP mode** for quick sends
15
+ - **Transfer history** with export and cleanup
16
+ - **Optional no-compress** mode (tar only)
17
+
18
+ ## Planned
19
+
20
+ - **CLI ↔ Browser**
21
+ - **Browser ↔ CLI**
22
+
23
+ ## Who It’s For
24
+
25
+ Portal is for anyone who wants a fast, local, no-fuss way to move files between devices without relying on external services. It is ideal for personal workflows and small team transfers on the same network.
26
+
27
+ ## Install
28
+
29
+ **Release Installers (Recommended)**
30
+
31
+ **Shell script (Linux/macOS)**
32
+
33
+ ```bash
34
+ curl --proto '=https' --tlsv1.2 -LsSf https://github.com/Spectra010s/portal/releases/download/v0.9.0/hiverra-portal-installer.sh | sh
35
+ ```
36
+
37
+ **PowerShell (Windows)**
38
+
39
+ ```powershell
40
+ powershell -ExecutionPolicy Bypass -c "irm https://github.com/Spectra010s/portal/releases/download/v0.9.0/hiverra-portal-installer.ps1 | iex"
41
+ ```
42
+
43
+ **npm (prebuilt binaries)**
44
+
45
+ ```bash
46
+ npm install hiverra-portal@0.9.0
47
+ ```
48
+
49
+ **Android / Termux**
50
+
51
+ ```bash
52
+ curl -LsSf https://github.com/Spectra010s/portal/releases/download/v0.9.0/hiverra-portal-android-installer.sh | sh
53
+ ```
54
+
55
+ **Direct download**
56
+
57
+ - Download the release asset for your OS from GitHub Releases.
58
+
59
+ **Build From Source**
60
+
61
+ - Install Rust
62
+
63
+ ```bash
64
+ cargo build -p hiverra-portal
65
+ ```
66
+
67
+ ## Quick Start
68
+
69
+ 1. Run setup
70
+
71
+ ```bash
72
+ portal config setup
73
+ ```
74
+
75
+ 1. On receiver
76
+
77
+ ```bash
78
+ portal receive
79
+ ```
80
+
81
+ 1. On sender
82
+
83
+ ```bash
84
+ portal send path/to/file
85
+ ```
86
+
87
+ ## Usage Examples
88
+
89
+ **Start receiver**
90
+
91
+ ```bash
92
+ portal receive
93
+ ```
94
+
95
+ **Send via discovery**
96
+
97
+ ```bash
98
+ portal send --to <username> path/to/file
99
+ ```
100
+
101
+ **Send via direct IP**
102
+
103
+ ```bash
104
+ portal send --address <ip> --port <port> path/to/file
105
+ ```
106
+
107
+ **Send a folder (recursive)**
108
+
109
+ ```bash
110
+ portal send -r path/to/folder
111
+ ```
112
+
113
+ **No-compress**
114
+
115
+ ```bash
116
+ portal send --no-compress path/to/file
117
+ ```
118
+
119
+ **History (list + export)**
120
+
121
+ ```bash
122
+ portal history
123
+ portal history export --detailed --output portal_history.json
124
+ ```
125
+
126
+ **Update**
127
+ To update Portal:
128
+
129
+ ```bash
130
+ portal update
131
+ ```
132
+
133
+ ## How to Run or Use It
134
+
135
+ Portal is a command-line tool. Common commands:
136
+
137
+ **Send a file**
138
+ Use this to send a specific file. If no file is specified, Portal will prompt you to select one.
139
+
140
+ ```bash
141
+ portal send <file_path>
142
+ ```
143
+
144
+ **Send with discovery (recommended)**
145
+ Sends to a user by username and verifies identity.
146
+
147
+ ```bash
148
+ portal send --to <username> <file_path>
149
+ ```
150
+
151
+ **Send via direct IP**
152
+ Use this when you already know the receiver’s IP and port.
153
+
154
+ ```bash
155
+ portal send --address <IP_ADDRESS> --port <PORT> <file_path>
156
+ ```
157
+
158
+ **Receive**
159
+ Puts Portal into listening mode to receive files.
160
+
161
+ ```bash
162
+ portal receive
163
+ ```
164
+
165
+ **Receive on a custom port**
166
+
167
+ ```bash
168
+ portal receive --port <PORT>
169
+ ```
170
+
171
+ **Configuration setup**
172
+ Interactive setup to configure username and default port.
173
+
174
+ ```bash
175
+ portal config setup
176
+ ```
177
+
178
+ **Set a configuration value**
179
+
180
+ ```bash
181
+ portal config set <key> <value>
182
+ ```
183
+
184
+ **Show a configuration value**
185
+
186
+ ```bash
187
+ portal config show <key>
188
+ ```
189
+
190
+ **List current configuration**
191
+
192
+ ```bash
193
+ portal config list
194
+ ```
195
+
196
+ ## Documentation
197
+
198
+ - [docs/index.md](https://github.com/Spectra010s/portal/blob/main/docs/index.md)
199
+ - [docs/install.md](https://github.com/Spectra010s/portal/blob/main/docs/install.md)
200
+ - [docs/usage.md](https://github.com/Spectra010s/portal/blob/main/docs/usage.md)
201
+ - [docs/cli-cli.md](https://github.com/Spectra010s/portal/blob/main/docs/cli-cli.md)
202
+ - [docs/troubleshooting.md](https://github.com/Spectra010s/portal/blob/main/docs/troubleshooting.md)
203
+ - [docs/faq.md](https://github.com/Spectra010s/portal/blob/main/docs/faq.md)
204
+
205
+ ## Author
206
+
207
+ Spectra010s
208
+
209
+ ## License
210
+
211
+ [LICENSE](https://github.com/Spectra010s/portal/blob/main/LICENSE)
212
+
213
+ > Hiverra Portal: A lightweight CLI tool to transfer files between devices locally or remotely.