Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support command line arguments to display budget information #60

Open
bvanelli opened this issue Aug 25, 2024 · 0 comments · May be fixed by #62
Open

Support command line arguments to display budget information #60

bvanelli opened this issue Aug 25, 2024 · 0 comments · May be fixed by #62
Labels
enhancement New feature or request

Comments

@bvanelli
Copy link
Owner

Description

The main strength of the Python library is to actually write easy to use CLI tools that could interact with the server itself.

My first idea was to implement "display only" functions as a proof of concept, and it the implementation makes sense eventually add the option to also add data. Keeping it simple, here is the proposal:

Main options:

  • -o or --output: table, for table view of the entries using rich tables, or json
  • --context, for selecting the context of the cli

Configuration:

  • ~/.actual/ folder on home directory would hold the config.yaml file for the configuration. Basic format:
config:
   defaultBudget: <budgetName>
   output: table
budgets:
    budget_name:
        url: <url of the actual server>
        password: <base 64 version of password>
        encryptionPassword: <base 64 version of password>
        fileId: file id on the remote

Main commands:

  • init: initializes an actual budget config, taking optionally --url, --password, --encryption-password, --context, --file
  • version: shows library version and server version
  • accounts: show all accounts
  • transactions: show all transactions
  • payees: show all payees
  • export: generates an export from the budget (for CLI backups)
@bvanelli bvanelli added the enhancement New feature or request label Aug 25, 2024
@bvanelli bvanelli linked a pull request Aug 29, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant