UNPKG

squarespace-cli

Version:

A CLI for doing random stuff with Squarespace.

github.com/Squarefront/squarespace-cli

Squarefront/squarespace-cli

88 lines (59 loc) • 2.21 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
Squarespace CLI ======= > **Note: This project is a WIP.** > A node CLI client for working with Squarespace ## Project Overview This project aims to provide some awesome Squarespace functionality from the command line. ### Setup ```shell npm i -g squarespace-cli sqs -h ``` ### Usage #### Export Content Export a Squarespace page. Bulk exporting is on the way. The CLI will export to your current working path. Run `pwd` in terminal to see your working directory. ```shell # export a page in JSON sqs export https://blog.squarespace.com # export a page in HTML sqs export https://blog.squarespace.com -f html # export a page in JSON with filename foo.json sqs export https://blog.squarespace.com --filename foo.json ``` #### Export Sitemap Export your sitemap in various formats.. ```shell # export full sitemap in xml sqs export-sitemap https://blog.squarespace.com # export ful sitemap in json sqs export-sitemap https://blog.squarespace.com -f json # export sitemap urls in plain text sqs export-sitemap https://blog.squarespace.com -f text ``` #### Create a Squarespace Website Create a new [Base Template](https://base-template.squarespace.com) website. This is a work in progress. I'm having issues with the cookie crumb authentication. ```shell # create a new base template website sqs create-site ``` ### Authentication and Credential Storage The CLI will prompt for your Squarespace credentials depending on your command. The CLI stores your credentials in your operating system's local keychain via [node-keytar](https://github.com/atom/node-keytar) and uses them to perform authenticated requests to Squarespace's API endpoints. #### Save Credentials During an Authenticated Request Using flag `--save` during a command that requires authentication will trigger credential storage. #### Delete Stored Credentials To remove stored credentials, simply run the following command. ```shell # delete stored credentials delete-credentials ``` ## Roadmap * Bulk export. * Parse sitemap. Chain to export. * Get site info. * Improved logging. * Lots of other cool stuff :) ### Support I'm largely using ES6/ES7, so this project may not work on older versions of Node.js. 6.0+ ftw :-D.