whitequark.org
[mirror] Command-line application for uploading a site to a git-pages server
Update terminology. NFC
+4
-4
README.md
+4
-4
README.md
···
1
git-pages-cli
2
=============
3
4
-
_git-pages-cli_ is a command-line application for uploading sites to [git-pages].
5
6
If you want to publish a site from a Forgejo Actions workflow, use [git-pages/action] instead.
7
···
39
317716dee4379c167e8b5ce9df38eb880e043e5a842d160fe8d5bb408ee0c191
40
```
41
42
-
To upload a site from a git repository available on the internet (`--password` may be omitted if the repository is allowlisted via DNS):
43
44
```console
45
$ git-pages-cli https://example.org --upload-git https://codeberg.org/username/example.org.git
46
$ git-pages-cli https://example.org --password xyz --upload-git https://codeberg.org/username/example.org.git
47
```
48
49
-
To upload a site from a directory on your machine:
50
51
```console
52
$ git-pages-cli https://example.org --password xyz --upload-dir site-contents
···
58
$ git-pages-cli https://example.org --password xyz --delete
59
```
60
61
-
It is not possible to upload a site to a domain for the first time using HTTPS, since the git-pages server is not allowed to acquire a TLS certificate for a domain before a site is published on that domain. Either use plain HTTP instead, or provide a hostname for which the server *does* have a TLS certificate using the `--server` option:
62
63
```console
64
$ git-pages-cli https://example.org --server grebedoc.dev --password xyz --upload-dir ...
···
1
git-pages-cli
2
=============
3
4
+
_git-pages-cli_ is a command-line application for publishing sites to [git-pages].
5
6
If you want to publish a site from a Forgejo Actions workflow, use [git-pages/action] instead.
7
···
39
317716dee4379c167e8b5ce9df38eb880e043e5a842d160fe8d5bb408ee0c191
40
```
41
42
+
To publish a site from a git repository available on the internet (`--password` may be omitted if the repository is allowlisted via DNS):
43
44
```console
45
$ git-pages-cli https://example.org --upload-git https://codeberg.org/username/example.org.git
46
$ git-pages-cli https://example.org --password xyz --upload-git https://codeberg.org/username/example.org.git
47
```
48
49
+
To publish a site from a directory on your machine:
50
51
```console
52
$ git-pages-cli https://example.org --password xyz --upload-dir site-contents
···
58
$ git-pages-cli https://example.org --password xyz --delete
59
```
60
61
+
It is not possible to publish a site to a domain for the first time using HTTPS, since the git-pages server is not allowed to acquire a TLS certificate for a domain before a site is published on that domain. Either use plain HTTP instead, or provide a hostname for which the server *does* have a TLS certificate using the `--server` option:
62
63
```console
64
$ git-pages-cli https://example.org --server grebedoc.dev --password xyz --upload-dir ...