peakurl 0.3.1 → 1.0.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/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # PeakURL - Command-Line Interface
2
2
 
3
+ ![PeakURL CLI](https://github.com/PeakURL/PeakURL/blob/main/.github/images/peakurl-cli.jpg?raw=1)
4
+
3
5
  The official command-line interface for PeakURL.
4
6
 
5
7
  Use `peakurl` to create short links, inspect existing links, and manage your PeakURL account from the terminal.
@@ -62,6 +64,7 @@ export PEAKURL_API_KEY=0123456789abcdef0123456789abcdef0123456789abcdef
62
64
  | `peakurl whoami` | Show the current authenticated account. |
63
65
  | `peakurl logout` | Remove saved local CLI credentials. |
64
66
  | `peakurl status` | Show the current system status snapshot for the site. |
67
+ | `peakurl core download` | Download and extract the latest PeakURL core package. |
65
68
  | `peakurl create <url>` | Create a new short link. |
66
69
  | `peakurl import <file>` | Import links from a local CSV, JSON, or XML file. |
67
70
  | `peakurl export` | Export accessible links as CSV, JSON, or XML. |
@@ -118,6 +121,18 @@ If you need the raw payload:
118
121
  peakurl status --json
119
122
  ```
120
123
 
124
+ Download and extract the latest PeakURL core package into the current directory:
125
+
126
+ ```bash
127
+ peakurl core download
128
+ ```
129
+
130
+ If the current directory already contains conflicting files, re-run with:
131
+
132
+ ```bash
133
+ peakurl core download --force
134
+ ```
135
+
121
136
  Delete a link:
122
137
 
123
138
  ```bash
@@ -211,4 +226,4 @@ export PEAKURL_DISABLE_UPDATE_CHECK=1
211
226
  - CLI docs: <https://peakurl.org/docs/cli>
212
227
  - API docs: <https://peakurl.org/docs/api>
213
228
  - npm package: <https://www.npmjs.com/package/peakurl>
214
- - Issues: <https://github.com/PeakURL/PeakURL-CLI/issues>
229
+ - Issues: <https://github.com/PeakURL/CLI/issues>