https://github.com/jmaczan/spellbook
🪄 Shell and Powershell scripts registry
https://github.com/jmaczan/spellbook
bash bash-script package-manager package-registry powershell powershell-script python registry self-hosted shell shell-script typescript
Last synced: 9 months ago
JSON representation
🪄 Shell and Powershell scripts registry
- Host: GitHub
- URL: https://github.com/jmaczan/spellbook
- Owner: jmaczan
- Created: 2022-03-02T16:23:31.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-16T12:49:31.000Z (about 2 years ago)
- Last Synced: 2024-12-27T20:13:10.973Z (10 months ago)
- Topics: bash, bash-script, package-manager, package-registry, powershell, powershell-script, python, registry, self-hosted, shell, shell-script, typescript
- Language: TypeScript
- Homepage: https://spellbook.maczan.pl
- Size: 1.39 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Citation: CITATION.cff
Awesome Lists containing this project
- jimsghstars - jmaczan/spellbook - 🪄 Shell and Powershell scripts registry (TypeScript)
README
# spellbook
Bash (and in the future Powershell) scripts registry
## Web App
A React app stored in `web/`.
You need to specify one environment variable (for example using `.env` file) - `REACT_APP_REGISTRY_URL` - which points to registry and ends with a slash (`/`):
```
REACT_APP_REGISTRY_URL=https://link.url/
```
Two other env variables are optional:
```
REACT_APP_PAYMENT_URL_SUBSCRIPTION=
REACT_APP_PAYMENT_URL_OTP=
```
They are links to payment processor, completely optional.
### Install
`npm install`
### Build
`npm run build`
### Run
`npm run start`
## CLI
Python CLI standalone app, stored in `cli/` directory
### Build
`./build.sh`
### Install
`./install.sh`
### Commands
#### Learn (add) script
`spell learn `
#### Forget (delete) script
`spell forget <script name>`
#### Show list of learned scripts
`spell list`
## API
Deprecated API for retrieving scripts. You can still use it anyway
### Build
`npm run build`
### Start
`npm run start`
## Registry
Contains all scripts in a separate directories. See [README](registry/README.md) in `registry/` for more detailed info
## Registry-utils
Python scripts for Registry
## License
Free to use for non-commercial usage
For commercial, pay $10 per year per user - [buy here](https://spellbook.maczan.pl/pricing)
## Author
Copyright 2022-2023 [Jędrzej Paweł Maczan](https://maczan.pl)