mirror of
https://github.com/actualbudget/actual.git
synced 2026-03-22 00:13:45 -05:00
67 lines
2.4 KiB
Markdown
67 lines
2.4 KiB
Markdown
This is the main project to run [Actual](https://github.com/actualbudget/actual), a local-first personal finance tool. It comes with the latest version of Actual, and a server to persist changes and make data available across all devices.
|
|
|
|
### Getting Started
|
|
|
|
Actual is a local-first personal finance tool. It is 100% free and open-source, written in NodeJS, it has a synchronization element so that all your changes can move between devices without any heavy lifting.
|
|
|
|
If you are interested in contributing, or want to know how development works, see our [contributing](https://actualbudget.org/docs/contributing/) document we would love to have you.
|
|
|
|
Want to say thanks? Click the ⭐ at the top of the page.
|
|
|
|
### Using the CLI tool
|
|
|
|
Node.js v22 or higher is required for the @actual-app/sync-server npm package
|
|
|
|
**Install globally with npm:**
|
|
|
|
```bash
|
|
npm install --location=global @actual-app/sync-server
|
|
```
|
|
|
|
After installing, you can execute actual-server commands directly in your terminal.
|
|
|
|
**Usage**
|
|
|
|
```bash
|
|
actual-server [options]
|
|
```
|
|
|
|
**Available options**
|
|
|
|
| Command | Description |
|
|
| ------------------- | ---------------------------- |
|
|
| `-h` or `--help` | Print this list and exit. |
|
|
| `-v` or `--version` | Print this version and exit. |
|
|
| `--config` | Path to the config file. |
|
|
| `--reset-password` | Reset your password |
|
|
|
|
**Examples**
|
|
|
|
Run with default configuration
|
|
|
|
```bash
|
|
actual-server
|
|
```
|
|
|
|
Run with custom configuration
|
|
|
|
```bash
|
|
actual-server --config ./config.json
|
|
```
|
|
|
|
Reset your password
|
|
|
|
```bash
|
|
actual-server --reset-password
|
|
```
|
|
|
|
### Documentation
|
|
|
|
We have a wide range of documentation on how to use Actual. This is all available in our [Community Documentation](https://actualbudget.org/docs/), including topics on [installing](https://actualbudget.org/docs/install/), [Budgeting](https://actualbudget.org/docs/budgeting/), [Account Management](https://actualbudget.org/docs/accounts/), [Tips & Tricks](https://actualbudget.org/docs/getting-started/tips-tricks) and some documentation for developers.
|
|
|
|
### Feature Requests
|
|
|
|
Current feature requests can be seen [here](https://github.com/actualbudget/actual/issues?q=is%3Aissue+label%3A%22needs+votes%22+sort%3Areactions-%2B1-desc). Vote for your favorite requests by reacting 👍 to the top comment of the request.
|
|
|
|
To add new feature requests, open a new Issue of the "Feature Request" type.
|