2023-12-08 19:27:00 +01:00
|
|
|
## About
|
|
|
|
|
|
2023-12-23 01:34:09 +01:00
|
|
|
Twenty helps you manage projects with a solution that runs on your computer
|
|
|
|
|
rather than in the cloud.
|
2023-12-08 19:27:00 +01:00
|
|
|
|
2023-12-22 22:23:10 +01:00
|
|
|
## Features
|
|
|
|
|
|
2023-12-23 02:12:53 +01:00
|
|
|
* Provides a web application that helps you manage projects.
|
2023-12-22 22:33:23 +01:00
|
|
|
* Provides a command-line utility to start / stop a web server, connect / disconnect a project.
|
2023-12-23 17:34:50 +01:00
|
|
|
* Works offline. Binds to `http//:localhost:2020` by default.
|
2023-12-22 22:55:12 +01:00
|
|
|
* Lightweight: Ruby, and SQLite3 are the primary runtime dependencies.
|
2023-12-22 22:23:10 +01:00
|
|
|
* Database: `~/.local/share/twenty/twenty.sqlite`.
|
|
|
|
|
* Easy to install: `gem install twenty`.
|
|
|
|
|
* Easy to use: `$ twenty up`.
|
|
|
|
|
|
2023-12-08 19:27:00 +01:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
|
|
Usage: twenty COMMAND [OPTIONS]
|
|
|
|
|
|
|
|
|
|
Commands:
|
|
|
|
|
up Start the twenty web server.
|
|
|
|
|
down Stop the twenty web server.
|
|
|
|
|
connect Connect a project to twenty.
|
|
|
|
|
disconnect Disconnect a project from twenty.
|
|
|
|
|
|
|
|
|
|
## Install
|
|
|
|
|
|
|
|
|
|
gem install twenty
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).
|
|
|
|
|
<br>
|
|
|
|
|
See [LICENSE](./LICENSE)
|
