https://github.com/ericc-ch/install-pocketbase
https://github.com/ericc-ch/install-pocketbase
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/ericc-ch/install-pocketbase
- Owner: ericc-ch
- License: agpl-3.0
- Created: 2025-03-04T06:46:38.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-04T15:05:39.000Z (over 1 year ago)
- Last Synced: 2025-12-06T20:54:40.044Z (7 months ago)
- Language: TypeScript
- Size: 49.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# install-pocketbase
Install PocketBase easily using `npx`!
## Usage
**Make sure you have `unzip` installed on your system.**
**Install the latest version:**
```bash
npx install-pocketbase@latest
```
**Install a specific version:**
```bash
npx install-pocketbase --tag
```
**Install for a specific platform:**
```bash
npx install-pocketbase --platform
```
**Interactive mode:**
```bash
npx install-pocketbase --interactive
```
## Programmatic Usage
You can also use `install-pocketbase` programmatically in your Node.js projects.
**Installation:**
```bash
npm install install-pocketbase
```
**Usage:**
```typescript
import { getDownloadUrl, install } from "install-pocketbase";
const downloadUrl = await getDownloadUrl({
tag: "latest",
platform: "linux_amd64",
});
await install(downloadUrl, {
onProgress: (progress, total) => {
console.log(`Downloaded ${progress} of ${total} bytes`);
},
});
```
## Options
- `--tag`, `-t`: Version tag to install. Defaults to `latest`.
- `--platform`, `-p`: Platform to install. Defaults to your OS platform and architecture.
- `--interactive`, `-i`: Interactive mode. Prompts you to select a version from the available releases. Defaults to `false`.
## Credits
This project uses [ungh](https://unjs.io/packages/ungh) by [unjs](https://unjs.io/). Thanks for the awesome API proxy!