Skip to content

Commit 25b9856

Browse files
authored
Merge pull request #18 from CloudCannon/feat/editing-subcommands
Add site editing subcommands
2 parents 42dd058 + 8273eec commit 25b9856

5 files changed

Lines changed: 614 additions & 20 deletions

File tree

README.md

Lines changed: 127 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -430,6 +430,7 @@ Upload a file to a site.
430430

431431
```sh
432432
cloudcannon sites files upload --site my-site ./local-file.html /uploaded-file.html
433+
cloudcannon sites files upload --site my-site ./local-file.html /uploaded-file.html --allow-overwrite
433434
```
434435

435436
**Flags**
@@ -438,7 +439,132 @@ cloudcannon sites files upload --site my-site ./local-file.html /uploaded-file.h
438439
|---|---|---|
439440
| `--site <name\|id\|uuid\|domain>` | The site name, ID, UUID, or domain (required) |
440441
| `--type <mime>` | MIME type of the file | |
441-
| `--overwrite` | Overwrite if the file already exists | `false` |
442+
| `--allow-overwrite` | Overwrite the destination if it already exists | `false` |
443+
444+
---
445+
446+
### `sites files move --site <name|id|uuid|domain> [src] [dest]`
447+
448+
Move a file within a site editing session.
449+
450+
```sh
451+
cloudcannon sites files move --site my-site content/old.md content/new.md
452+
cloudcannon sites files move --site my-site content/old.md content/new.md --allow-overwrite
453+
```
454+
455+
**Flags**
456+
457+
| Flag | Description | Default |
458+
|---|---|---|
459+
| `--site <name\|id\|uuid\|domain>` | The site name, ID, UUID, or domain (required) | |
460+
| `--allow-overwrite` | Overwrite the destination if it already exists | `false` |
461+
462+
---
463+
464+
### `sites files clone --site <name|id|uuid|domain> [src] [dest]`
465+
466+
Clone a file to a new path within a site editing session. The source file is left unchanged.
467+
468+
```sh
469+
cloudcannon sites files clone --site my-site content/post.md content/post-copy.md
470+
cloudcannon sites files clone --site my-site content/post.md content/post-copy.md --allow-overwrite
471+
```
472+
473+
**Flags**
474+
475+
| Flag | Description | Default |
476+
|---|---|---|
477+
| `--site <name\|id\|uuid\|domain>` | The site name, ID, UUID, or domain (required) | |
478+
| `--allow-overwrite` | Overwrite the destination if it already exists | `false` |
479+
480+
---
481+
482+
### `sites files delete --site <name|id|uuid|domain> [target]...`
483+
484+
Delete one or more files within a site editing session. The files are removed from the repository on commit.
485+
486+
```sh
487+
cloudcannon sites files delete --site my-site content/old.md
488+
cloudcannon sites files delete --site my-site content/a.md content/b.md --discard-unsaved
489+
```
490+
491+
**Flags**
492+
493+
| Flag | Description | Default |
494+
|---|---|---|
495+
| `--site <name\|id\|uuid\|domain>` | The site name, ID, UUID, or domain (required) | |
496+
| `--discard-unsaved` | Discard any unsaved edits to the files | `false` |
497+
498+
---
499+
500+
### `sites files restore --site <name|id|uuid|domain> [target]...`
501+
502+
Restore one or more deleted files within a site editing session, removing the pending delete entries.
503+
504+
```sh
505+
cloudcannon sites files restore --site my-site content/old.md
506+
cloudcannon sites files restore --site my-site content/a.md content/b.md
507+
```
508+
509+
**Flags**
510+
511+
| Flag | Description | Default |
512+
|---|---|---|
513+
| `--site <name\|id\|uuid\|domain>` | The site name, ID, UUID, or domain (required) | |
514+
515+
---
516+
517+
### `sites files discard --site <name|id|uuid|domain> [target]...`
518+
519+
Discard one or more session files from a site editing session, permanently deleting their pending edits.
520+
521+
```sh
522+
cloudcannon sites files discard --site my-site content/old.md
523+
cloudcannon sites files discard --site my-site content/a.md content/b.md
524+
```
525+
526+
**Flags**
527+
528+
| Flag | Description | Default |
529+
|---|---|---|
530+
| `--site <name\|id\|uuid\|domain>` | The site name, ID, UUID, or domain (required) | |
531+
532+
---
533+
534+
### `sites files list-edits --site <name|id|uuid|domain>`
535+
536+
List pending edits on the site's current editing session.
537+
538+
```sh
539+
cloudcannon sites files list-edits --site my-site
540+
cloudcannon sites files list-edits --site my-site --verbose
541+
```
542+
543+
**Flags**
544+
545+
| Flag | Description | Default |
546+
|---|---|---|
547+
| `--site <name\|id\|uuid\|domain>` | The site name, ID, UUID, or domain (required) | |
548+
| `--verbose` | Print the full objects returned by the API | `false` |
549+
550+
---
551+
552+
### `sites files commit --site <name|id|uuid|domain> [path]...`
553+
554+
Commit a site editing session, pushing changes to the connected repository.
555+
556+
```sh
557+
cloudcannon sites files commit --site my-site --all
558+
cloudcannon sites files commit --site my-site content/a.md content/b.md --message "Publish posts"
559+
```
560+
561+
**Flags**
562+
563+
| Flag | Description | Default |
564+
|---|---|---|
565+
| `--site <name\|id\|uuid\|domain>` | The site name, ID, UUID, or domain (required) | |
566+
| `--all` | Commit all files in the editing session | `false` |
567+
| `--message <msg>` | Commit message | |
442568

443569
---
444570

package-lock.json

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
"@cloudcannon/configuration-loader": "0.0.10",
6464
"@cloudcannon/configuration-types": "0.0.58",
6565
"@cloudcannon/gadget": "0.0.33",
66-
"@cloudcannon/sdk": "0.0.7",
66+
"@cloudcannon/sdk": "0.0.8",
6767
"ajv": "8.20.0",
6868
"citty": "0.2.2",
6969
"fastest-levenshtein": "1.0.16",

0 commit comments

Comments
 (0)