@studyfetch/sfdeploy
v0.12.2
Published
Build and deploy StudyFetch apps, APIs, and Chrome side-panel tools.
Downloads
1,393
Readme
sfdeploy
Build and deploy StudyFetch apps, APIs, and browser tools to
https://<project>.studyfetchdeploy.com. Node.js 20+ is required.
npm i -g @studyfetch/sfdeploy
sfdeploy login
mkdir my-app
cd my-app
sfdeploy init my-app
sfdeploy projects create my-app --visibility private
sfdeploy deployinit writes into the current directory. Use an empty folder for a new app.
Chrome apps
SFDeploy for Chrome is one shared extension that opens your deployed apps in Chrome's side panel. An app can call its own published scripts to read or change the current website and continue across pages after the user starts it. Use it for page widgets, collecting visible page data, form helpers, or browser workflows.
Download the private extension and follow the screenshot setup. Sign in to the Hub with StudyFetch in the same Chrome profile. Chrome 138+ and Allow user scripts are required. App users do not need the CLI.
Create a complete Page Colors app with CLI 0.12.2+:
mkdir my-chrome-app
cd my-chrome-app
sfdeploy init my-chrome-app --example chrome-colors
sfdeploy projects create my-chrome-app --visibility private
sfdeploy deployOpen a website, click SFDeploy in Chrome, select Page Colors, and click Apply to
page. The app calls sfdeploy.run('color-widget', { color }); its script changes
the page, adds a color widget, and returns JSON. Reset restores the page. The
starter includes the full interface, Worker, script, and configuration.
For an existing app, add chrome_extension to its sfdeploy.json, serve a panel
page, and declare page scripts under actions. Read the complete guide before
implementing; it covers the SDK, inputs/results, navigation, cleanup, access, and QA:
sfdeploy docs chrome
sfdeploy --example-doc chrome-colorsApp code and scripts update when you deploy. The unpacked extension itself needs a separate download and reload; unsupported versions are blocked. Updating the CLI does not update Chrome.
Coding agents
The package installs the sfdeploy skill for supported local agents. Refresh it
with sfdeploy install-skills. Technical guidance is available on demand:
sfdeploy --llm-prompt # full agent instructions
sfdeploy examples # working starters
sfdeploy --example-doc chrome-colors # every file and setup step
sfdeploy docs # topic index
sfdeploy docs chrome # browser apps and the SDK
sfdeploy docs design # StudyFetch UI guidanceBrowser app interfaces should stay simple: one App with clear task buttons, results, and short errors. Keep technical documentation in agent guidance.
Read the agent skill and Chrome guide online, or browse apps in the Hub.
