@quicksnip/cli
v0.1.2
Published
Production-ready QuickSnip CLI for the v1 Developer API
Downloads
270
Maintainers
Readme
QuickSnip CLI
QuickSnip CLI gives you direct access to QuickSnip from the terminal.
- Website:
https://quicksnip.in - Developer docs:
https://quicksnip.in/documentation/developer
Install
npm install -g @quicksnip/cli
# or
pnpm add -g @quicksnip/cliOne-off usage:
npx @quicksnip/cli --helpQuick Start
- Create a Personal Access Token in QuickSnip.
- Log in from the terminal:
qs auth login
qs whoami- Save your first snippet or command:
qs snippet add --title auth-helper --file ./src/auth.ts --tags auth,backend
qs commands create --title build-server --language bash --code "pnpm dev"Common Commands
qs auth status
qs config get
qs snippets list --language typescript
qs commands run "build server"
qs snippet publish <id>
qs snippet link <id>Configuration
The CLI uses https://quicksnip.in by default.
Override when needed:
qs config set baseUrl https://quicksnip.in
qs config set output jsonEnvironment variables:
export QUICKSNIP_API_KEY=your_pat_here
export QUICKSNIP_BASE_URL=https://quicksnip.inPublishing To npm
From the repository root:
pnpm --filter @quicksnip/cli test
pnpm --filter @quicksnip/cli publish --access publicBefore publishing:
- bump the version in
apps/cli/package.json - confirm the production API is live at
https://quicksnip.in - confirm the docs page is updated at
https://quicksnip.in/documentation/developer
More Help
- Website:
https://quicksnip.in - Docs:
https://quicksnip.in/documentation/developer - CLI help:
qs --help
