Easyledger CLI (eledger) 💰

Easyledger is a simple command-line interface (CLI) wrapper for ledger-cli, designed to streamline your accounting tasks. It provides intuitive helpers to manage different ledgers, configure their locations, and effortlessly add transactions.

✨ Features

• Interactive Commands: Seamlessly add transactions and ledgers with guided, interactive prompts.
• Configuration Management: Easily set, get, and list CLI configuration values.
• Ledger File Management: Add, delete, rename, list, and switch between multiple ledger files.
• Transaction Entry: Quickly add transactions to your active ledger.

🚀 Installation

To get started with eledger, install the globally from npm:

npm run i -g easy-ledger-cli

📖 Usage

Once installed, you can use the eledger command from any terminal. You would need to have ledger-cli installed to leverage it for reports. eledgeris only for registering transactions, stocks, ledgers, etc.

Global Help

Get a quick overview of all available commands:

eledger --help

⚙️ Configuration Commands (eledger config)

Manage general settings for your CLI.

• List all configurations:

  eledger config list

• Get a specific configuration value:

  eledger config get <key>

  Example: eledger config get activeLedger

• Set a configuration value:

  eledger config set <key> <value>

  Example: eledger config set currency USD

📚 Ledger Management Commands (eledger config ledger)

Handle your various ledger files.

• Add a new ledger:

  eledger config ledger add [name] [path]

  If name or path are not provided, you will be prompted interactively. If no path is provided, a default file will be created in ~/.ledger/ledgers/<name>.dat.

  Examples:

  eledger config ledger add personal-finances ~/Documents/finances/personal.dat
  eledger config ledger add work-expenses
  eledger config ledger add # interactive prompt

• List all configured ledgers:

  eledger config ledger list

• Set an active ledger:

  eledger config ledger use <name>

  Example: eledger config ledger use personal-finances

• Rename a ledger:

  eledger config ledger rename <oldName> -n <newName>

  Example: eledger config ledger rename personal-finances -n my-finances

• Delete a ledger:

  eledger config ledger del <name>

  Example: eledger config ledger del work-expenses

📝 Accounts management commands (eledger config accounts)

Allows the user to manage their accounts. Accounts are used while registering transactions. This config tool will allow you to add, delete and rename accounts. Then when adding a new transaction, you will be able to select existing accounts instead of having to type them all the time and introducing errors.

📝 Transaction Entry (eledger ts)

Add new transactions to your currently active ledger. This command is interactive by default if arguments are missing.

• Add a transaction (interactive):

  eledger ts

  You will be prompted for payee, accounts, amount, and other details.

• Add a transaction (with arguments):

  eledger ts <payee> <debit_account> <amount> [options]

  Examples:

  eledger ts "Groceries" "Expenses:Food" "$54.25"
  eledger ts "Salary" "Income:Salary" "$-2500.00" -c "Assets:Bank" --desc "Monthly salary" -d "2023/11/01"

  For more details on arguments and options, run eledger ts --help.

🤝 Contributing

Contributions are welcome! Please feel free to open an issue or submit a pull request.

📄 License

This project is licensed under the ISC License. See the LICENSE file for details.