📦➔🦋 Store and retrieve files on the Atmosphere
README: improve usage
+49
-14
+49
-14
README.md
+49
-14
README.md
···
7
7
<em>Written entirely in Bash Shell. No <span title="Deno is pretty cool tho">NodeJS</span> here!</em>
8
8
</p>
9
9
10
-
<p align="center">
11
-
<strong>
12
-
<a href="https://github.com/ziodotsh/atfile/releases/latest">⬇️ Get ATFile</a> |
13
-
<a href="https://tangled.sh/@zio.sh/atfile/issues/new">💣 Submit Issue</a> |
14
-
<a href="https://bsky.app/profile/did:web:zio.sh"> 🦋 @zio.sh</a>
15
-
</strong>
16
-
</p>
17
-
18
10
<hr />
19
11
20
12
## ✨ Quick Start
21
13
22
14
```sh
23
15
curl -sSL https://zio.sh/atfile/install.sh | bash
24
-
echo 'ATFILE_USERNAME="<your-atproto-username>"' > ~/.config/atfile.env # e.g. alice.bsky.social, did:plc:vdjlpwlhbnug4fnjodwr3vzh, did:web:twitter.com
16
+
echo 'ATFILE_USERNAME="<your-atproto-username>"' > ~/.config/atfile.env # e.g. alice.bsky.social, did:plc:vdjlpwlhbnug4fnjodwr3vzh, did:web:twitter.com
25
17
echo 'ATFILE_PASSWORD="<your-atproto-password>"' >> ~/.config/atfile.env
26
18
atfile help
27
19
```
28
20
29
-
## 👀 Using
21
+
## 👀 Detailed Usage
30
22
31
23
### ✅ Requirements
32
24
···
59
51
* To change this on Bluesky PDS, set `PDS_BLOB_UPLOAD_LIMIT=<bytes>`
60
52
* If the PDS is running behind Cloudflare, the Free plan imposes a 100MB upload limit
61
53
* This tool, nor setting a higher filesize limit, **does not workaround [video upload limits on Bluesky](https://bsky.social/about/blog/09-11-2024-video).** Videos are served via a [CDN](https://video.bsky.app), and adding larger videos to post records yields errors
54
+
55
+
### ⬇️ Downloading & Installing
56
+
57
+
There are three ways of installing ATFile. Either:
62
58
63
-
### 🤔 _(Todo)_
59
+
#### Automatic ("`curl|bash`")
60
+
61
+
```
62
+
curl -sSL https://zio.sh/atfile/install.sh | bash
63
+
```
64
+
65
+
This will automatically fetch the latest version of ATFile and install it in an appropriate location, as well as creating a blank configuration file. Once downloaded and installed, the locations used will be output. They are as follows:
66
+
67
+
* **Linux/Windows/BSD/Solaris**
68
+
* Install: `$HOME/.local/bin/atfile`
69
+
* As `sudo`/`root`: `/usr/local/bin/atfile`
70
+
* Config: `$HOME/.config/atfile.env`
71
+
* As `root` (not `sudo`): `/root/.config/atfile.env`
72
+
* **macOS**
73
+
* Install: `$HOME/.local/bin/atfile`
74
+
* As `sudo`/`root`: `/usr/local/bin/atfile`
75
+
* Config: `$HOME/Library/Application Support/atfile.env`
76
+
* As `root` (not `sudo`): `/root/.config/atfile.env`
77
+
* **Haiku**
78
+
* Install: `/boot/system/non-packaged/bin/atfile`
79
+
* Config: `$HOME/config/settings/atfile.env`
80
+
* `$HOME` is **always** `/home` on Haiku
81
+
82
+
If `$XDG_CONFIG_HOME` is set, this will overwrite the config directory (e.g. setting `XDG_CONFIG_HOME=$HOME/.local/share/atfile` will result in the config being stored at `$HOME/.local/share/atfile/atfile.env`).
83
+
84
+
Custom config paths are supported, but set after-the-fact — see **Manually** below.
85
+
86
+
#### Manually
87
+
88
+
To install manually, see [tags on @zio.sh/atfile](https://tangled.sh/@zio.sh/atfile/tags), and download the required version under **Artifacts**. This can be stored and run from anywhere (and is identical to the version `curl|bash` fetched — this installed version can also be moved to custom locations at whim).
89
+
90
+
Don't forget to mark as executable with `chmod +x atfile.sh`. It's also a good idea to remove the version from the filename, as ATFile can update itself (with `atfile update`) and will overwrite the file (this functionality can be disabled with `ATFILE_DISABLE_UPDATER=1`).
91
+
92
+
Config locations are identical to those above (see **Automatic ("`curl|bash`")** above). To use a custom path, set `$ATFILE_PATH_CONF`. Variables can also be used (and overridden) with exports — see **`atfile help` ➔ Environment Variables** for more.
93
+
94
+
#### Repository
95
+
96
+
If you've pulled this repository, you can also use ATFile by simply calling `./atfile.sh` — it functions just as a regular compiled version of ATFile, including reading from the same config file. Debug messages are turned on by default: disable these by setting `ATFILE_DEBUG=0`.
97
+
98
+
**Using a development version against your ATProto account could potentially inadvertently damage records.**
64
99
65
-
_(Todo)_
100
+
### Using
101
+
102
+
See `atfile help`.
66
103
67
104
## 🏗️ Building
68
105
69
106
_(Todo)_
70
-
71
-
---
72
107
73
108
## ⌨️ Contributing
74
109