mirror of
https://github.com/actualbudget/actual.git
synced 2026-04-28 18:40:34 -05:00
Update documentation to replace "CLI tool" with "Server CLI" for consistency across multiple files. This change clarifies the distinction between the command-line interface for the Actual Budget application and the sync-server CLI tool.
This commit is contained in:
@@ -11,7 +11,7 @@ The CLI is **experimental** and its commands, options, and behavior are **likely
|
||||
The `@actual-app/cli` package provides a command-line interface for interacting with your Actual Budget data. It connects to your sync server and lets you query and modify budgets, accounts, transactions, categories, payees, rules, schedules, and more — all from the terminal.
|
||||
|
||||
:::note
|
||||
This is different from the [sync-server CLI tool](../install/cli-tool.md) (`@actual-app/sync-server`), which is used to host and manage the Actual server itself.
|
||||
This is different from the [Server CLI](../install/cli-tool.md) (`@actual-app/sync-server`), which is used to host and manage the Actual server itself.
|
||||
:::
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -4,7 +4,7 @@ In the open-source version of Actual, there are 3 NPM packages:
|
||||
|
||||
- [@actual-app/api](https://www.npmjs.com/package/@actual-app/api): The API for the underlying functionality. This includes the entire backend of Actual, meant to be used with Node.
|
||||
- [@actual-app/web](https://www.npmjs.com/package/@actual-app/web): A web build that will serve the app with a web frontend. This includes both the frontend and backend of Actual. It includes the backend as well because it's built to be used as a Web Worker.
|
||||
- [@actual-app/sync-server](https://www.npmjs.com/package/@actual-app/sync-server): The entire sync-server and underlying web client in one package. This includes a CLI tool, meant to be used with Node.
|
||||
- [@actual-app/sync-server](https://www.npmjs.com/package/@actual-app/sync-server): The entire sync-server and underlying web client in one package. This includes the Server CLI, meant to be used with Node.
|
||||
|
||||
All packages and the main Actual release are versioned together. That makes it clear which version of the package should be used with the version of Actual.
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ For most cases, we suggest opting for one of the simpler alternatives:
|
||||
|
||||
- [Pikapods](/docs/install/pikapods)
|
||||
- [Desktop Client](/download)
|
||||
- [CLI tool](/docs/install/cli-tool)
|
||||
- [Server CLI](/docs/install/cli-tool)
|
||||
- [Docker](/docs/install/docker)
|
||||
|
||||
:::
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
---
|
||||
title: 'CLI tool'
|
||||
title: 'Server CLI'
|
||||
---
|
||||
|
||||
## Hosting Actual with the CLI tool
|
||||
## Hosting Actual with the Server CLI
|
||||
|
||||
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](https://www.npmjs.com/package/@actual-app/sync-server).
|
||||
|
||||
### Installing the CLI tool
|
||||
### Installing the Server CLI
|
||||
|
||||
Node.js v22 or higher is required for the `@actual-app/sync-server` npm package
|
||||
|
||||
@@ -22,7 +22,7 @@ Once installed, you can execute commands directly from your terminal using `actu
|
||||
|
||||
> Before running the tool, navigate to the directory that you wish your files to be located.
|
||||
|
||||
Run the CLI tool with the following syntax:
|
||||
Run the Server CLI with the following syntax:
|
||||
|
||||
```bash
|
||||
actual-server [options]
|
||||
@@ -67,7 +67,7 @@ Reset your password
|
||||
actual-server --reset-password
|
||||
```
|
||||
|
||||
### Updating the CLI tool
|
||||
### Updating the Server CLI
|
||||
|
||||
The sync server can be updated with a simple command.
|
||||
|
||||
@@ -75,7 +75,7 @@ The sync server can be updated with a simple command.
|
||||
npm update -g @actual-app/sync-server
|
||||
```
|
||||
|
||||
### Uninstalling the CLI tool
|
||||
### Uninstalling the Server CLI
|
||||
|
||||
The sync server can be uninstalled with a simple command.
|
||||
|
||||
|
||||
@@ -47,7 +47,7 @@ While running a server can be a complicated endeavor, we've tried to make it fai
|
||||
|
||||
- If you're not comfortable with the command line and are willing to pay a small amount of money to have your version of Actual hosted on the cloud for you, we recommend [PikaPods](pikapods.md).[^2]
|
||||
- If you're willing to run a few commands in the terminal:
|
||||
- You can run the server with a simple command using the [CLI tool](cli-tool.md)
|
||||
- You can run the server with a simple command using the [Server CLI](cli-tool.md)
|
||||
- [Fly.io](fly.md) also offers cloud hosting for a similar amount of money.
|
||||
- If you want to use Docker, we have instructions for [using our provided Docker containers](docker.md).
|
||||
- You could [build Actual from source](build-from-source.md) on macOS, Windows, or Linux if you don't want to use a tool like Docker. (This method is the best option if you want to contribute to Actual's development!)
|
||||
|
||||
@@ -78,7 +78,7 @@ Actual has two parts, the client and a sync server. The primary task of the sync
|
||||
|
||||
- [PikaPods](/docs/install/pikapods)
|
||||
- [Fly.io](/docs/install/fly)
|
||||
- [CLI Tool](/docs/install/cli-tool)
|
||||
- [Server CLI](/docs/install/cli-tool)
|
||||
- [Docker Install](/docs/install/docker)
|
||||
- [Build from source](/docs/install/build-from-source)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user