0bc8db4ed5
**To be merged on the next release.** Goes with the new @actual-app/sync-server package: https://github.com/actualbudget/actual/pull/4798 **Pages changed:** - https://deploy-preview-680.www.actualbudget.org/docs/install/ - https://deploy-preview-680.www.actualbudget.org/docs/install/cli-tool - https://deploy-preview-680.www.actualbudget.org/docs/contributing/releasing - https://deploy-preview-680.www.actualbudget.org/docs/config **Notable changes** - New CLI Tool docs - Cutting a release - we no longer need to manually publish any npm packages. --------- Co-authored-by: Julian Dominguez-Schatz <julian.dominguezschatz@gmail.com>
1.8 KiB
title
| title |
|---|
| CLI tool |
Hosting Actual with the CLI tool
The Actual sync-server is available as an NPM package. The package is designed to make running the sync-server as easy as possible and is published to the official NPM registry under @@actual-app/sync-server.
Installing the CLI tool
Node.js v18 or higher is required for the @actual-app/sync-server npm package
Install globally with npm:
npm install --location=global @actual-app/sync-server
Once installed, you can execute commands directly from your terminal using actual-server.
Usage
Before running the tool, navigate to the directory that you wish your files to be located.
Run the CLI tool with the following syntax:
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. |
Default values
If no --config option is set, Actual will search for a config.json file in the current directory. If it exists it will be used. If it doesn't exist, Actual will set a Default Configuration.
Examples
Run with Default Configuration:
actual-server
Run with JSON Configuration:
actual-server --config ./custom-config.json
Run with Environment Variable Configuration:
ACTUAL_DATA_DIR=./custom-directory actual-server --config ./config.json
Updating the CLI tool
The sync server can be updated with a simple command.
npm update -g @actual-app/sync-server