Skip to main content

Ghost Site

@aaronge/ghost-sitev2026.09.18.1· 18d agoMODELS
01README

Manage a Ghost site's Admin API surface — site health, theme upload/activation, content export.

02Models1
@aaronge/ghost-sitev2026.09.18.1ghost_site.ts

Global Arguments

ArgumentTypeDescription
apiUrlurlGhost site base URL, e.g. https://example.com (no trailing slash).
adminApiKeystringGhost Admin API Key in '<id>:<secret>' format, from Settings →
fn sync()
Fetch current site info (title, description, url, version).
fn uploadTheme(zipPath: string)
Upload a theme zip via POST /themes/upload/. Does not activate it — run activateTheme afterward.
ArgumentTypeDescription
zipPathstringLocal path to the theme .zip file.
fn activateTheme(name: string)
Activate a previously uploaded theme via PUT /themes/{name}/activate/.
ArgumentTypeDescription
namestringTheme name (the 'name' field from uploadTheme's result, not the zip filename).
fn exportContent()
Full JSON content export via GET /db/. NOTE: as of Ghost 6.64,

Resources

site(infinite)— Site info from GET /site/ — title, description, url, Ghost version.
theme(infinite)— Result of a theme upload or activation, including gscan warnings/errors.

Files

export(application/json)— Full JSON content export from GET /db/ — app-level backup, a useful complement to whatever infra-level DB backup you run.
03Stats
A
100 / 100
Downloads
14
Archive size
8.3 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
04Platforms