mirror of
https://github.com/cpvalente/ontime.git
synced 2026-08-03 06:28:01 +00:00
Carlos Valente
1849b4d39f
* chore: migrate eslint to oxlint * chore: migrate prettier to oxfmt * chore: migrate typescript * chore: toThrow should have a expected value * chore: cast test value as Day * chore: small title fix * chore: mocks should be hoisted * chore: incorrect async useage * chore: test should be inside description * chore: test sohuld include an expeced * chore: oxfmt --------- Co-authored-by: alex-Arc <omnivox@LAPTOP-RC5SNBVV.localdomain>
53 lines
1.7 KiB
Markdown
53 lines
1.7 KiB
Markdown
# Ontime CLI
|
|
|
|
|
|
|
|
> Ontime is an application for managing rundown and event timers.
|
|
|
|
Congratulations! You got this far into Ontime's rabbit hole and want to manage your installation.
|
|
|
|
The CLI tool is a fast and lightweight way of installing Ontime and is perfect for self-hosting and headless installs.
|
|
|
|
## Getting started
|
|
|
|
### Prerequisites
|
|
|
|
You will need to have installed the correct version of node.js
|
|
Please check [the app engines declaration](https://github.com/cpvalente/ontime/blob/master/package.json) for the correct version.
|
|
|
|
### Running Ontime
|
|
|
|
To get Ontime running, all you need to do is install it in your system using your package manager of choice:
|
|
|
|
Install globally in your system
|
|
|
|
```bash
|
|
npm install -g @getontime/cli
|
|
```
|
|
|
|
... and run using the installed script
|
|
|
|
```bash
|
|
ontime
|
|
```
|
|
|
|
Or install and run ontime (the installation here is temporary for the duration of the session)
|
|
|
|
```bash
|
|
npx install @getontime/cli
|
|
```
|
|
|
|
## Links
|
|
|
|
- [Ontime's repository](https://github.com/cpvalente/ontime)
|
|
- [Ontime's documentation](https://docs.getontime.no/)
|
|
- [Ontime's website](https://getontime.no/)
|
|
|
|
## Sponsoring
|
|
|
|
You can help the development of this project or say thank you with a one time donation. \
|
|
See the [terms of donations](https://github.com/cpvalente/ontime/blob/master/SPONSOR.md)
|
|
|
|
[](https://github.com/sponsors/cpvalente)
|
|
[](https://www.buymeacoffee.com/cpvalente)
|