2023-12-08 19:27:00 +01:00
|
|
|
## About
|
|
|
|
|
|
2024-01-14 05:59:30 +01:00
|
|
|
Twenty helps you manage your projects with a web application
|
|
|
|
|
that runs on your computer with a minimal amount of effort.
|
2023-12-08 19:27:00 +01:00
|
|
|
|
2023-12-22 22:23:10 +01:00
|
|
|
## Features
|
|
|
|
|
|
2024-01-13 22:16:08 +01:00
|
|
|
* Provides a command-line utility to start / stop a web server.
|
|
|
|
|
* Connect / disconnect a project from the command line.
|
2023-12-23 17:34:50 +01:00
|
|
|
* Works offline. Binds to `http//:localhost:2020` by default.
|
2024-01-14 05:59:30 +01:00
|
|
|
* Minimal: Ruby, and SQLite3 are the primary runtime dependencies.
|
2024-01-13 22:16:08 +01:00
|
|
|
* Easy to install, easy to use.
|
2023-12-22 22:23:10 +01:00
|
|
|
|
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.
|
2023-12-23 20:23:55 +01:00
|
|
|
migrate Migrate the database.
|
2023-12-26 03:12:57 +01:00
|
|
|
console Start the twenty developer console.
|
2023-12-08 19:27:00 +01:00
|
|
|
|
|
|
|
|
## Install
|
|
|
|
|
|
|
|
|
|
gem install twenty
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
[BSD Zero Clause](https://choosealicense.com/licenses/0bsd/).
|
|
|
|
|
<br>
|
|
|
|
|
See [LICENSE](./LICENSE)
|
