Man page - freexian(1)
Packages contas this manual
Package: python3-pyxian
apt-get install python3-pyxian
apt-get install python3-pyxian
Manuals in package:
Documentations in package:
Manual
| FREEXIAN(1) | User Commands | FREEXIAN(1) |
NAME
freexian - CLI for common Freexian operations
DESCRIPTION
usage: freexian [-h]
- {give-back-hours,grant-extra-hours,monthly-report,invoice-summary,record-invoice,repos,status,config,update} ...
CLI for common Freexian operations
positional arguments:
- {give-back-hours,grant-extra-hours,monthly-report,invoice-summary,record-invoice,repos,status,config,update}
- actions
- give-back-hours
- Give back unused hours
- grant-extra-hours
- Grant extra hours
- monthly-report
- Produce the monthly report for a Freexian collaborator/contributor
- invoice-summary
- Produce a yearly invoicing summary for one or all contributors
- record-invoice
- Record an invoice sent by a Freexian collaborator
- repos
- Show and manage information about pyxian repositories
- status
- Show general information
- config
- Show configuration
- update
- Update the Freexian meta-repository
options:
- -h, --help
- show this help message and exit
GIVE-BACK-HOURS SUBCOMMAND
usage: freexian give-back-hours [-h] [-v] [--debug] [--coordinator]
--MONTH YYYY-MM
options:
- -h, --help
- show this help message and exit
- -v, --verbose
- verbose output
- --debug
- debugging output
- --coordinator
- run as the coordinator (change nicks without suggesting how to save changes)
- --month, -m YYYY-MM
- reporting month. Default: previous month if today is the 19th or earlier, otherwise current month
GRANT-EXTRA-HOURS SUBCOMMAND
usage: freexian grant-extra-hours [-h] [-v] [--debug] [--coordinator]
options:
- -h, --help
- show this help message and exit
- -v, --verbose
- verbose output
- --debug
- debugging output
- --coordinator
- run as the coordinator (change nicks without suggesting how to save changes)
- --month, -m YYYY-MM
- reporting month. Default: previous month if today is the 19th or earlier, otherwise current month
MONTHLY-REPORT SUBCOMMAND
usage: freexian monthly-report [-h] [-v] [--debug] [--month YYYY-MM]
options:
- -h, --help
- show this help message and exit
- -v, --verbose
- verbose output
- --debug
- debugging output
- --month, -m YYYY-MM
- reporting month. Default: previous month if today is the 19th or earlier, otherwise current month
INVOICE-SUMMARY SUBCOMMAND
usage: freexian invoice-summary [-h] [-v] [--debug] [--year YEAR] [--all]
COLLABORATOR
positional arguments:
- collaborator
- LedgerName of collaborator. Default: from configuration
options:
- -h, --help
- show this help message and exit
- -v, --verbose
- verbose output
- --debug
- debugging output
- --year, -y YEAR
- reporting year. Default: current year
- --all, -a
- report for all collaborators
- --csv
- generate report in CSV format
RECORD-INVOICE SUBCOMMAND
usage: freexian record-invoice [-h] [-v] [--debug] [--date DATE] [--year YEAR]
- [--lts LTS] [--force] [--quick] [--dry-run]
- person invoice [amount]
positional arguments:
options:
- -h, --help
- show this help message and exit
- -v, --verbose
- verbose output
- --debug
- debugging output
- --date DATE
- Invoice date. Default: today
- --year YEAR
- Accounting year. Default: previous year if today is the 19th of January or earlier, otherwise current year
- --lts LTS
- Amount in euros for LTS/ELTS work (without VAT)
- --force, -f
- Override safety checks
- --quick, -q
- Skip git pulls
- --dry-run, -n
- Do not perform changes
REPOS SUBCOMMAND
usage: freexian repos [-h] [-v] [--debug] [--check | --list | --write-default]
options:
- -h, --help
- show this help message and exit
- -v, --verbose
- verbose output
- --debug
- debugging output
- --check, -c
- check status of repositories
- --list
- list project mappings
- --write-default
- write default config instead of user config
STATUS SUBCOMMAND
usage: freexian status [-h] [-v] [--debug]
options:
- -h, --help
- show this help message and exit
- -v, --verbose
- verbose output
- --debug
- debugging output
CONFIG SUBCOMMAND
usage: freexian config [-h] [-v] [--debug] [--init] [--full]
options:
- -h, --help
- show this help message and exit
- -v, --verbose
- verbose output
- --debug
- debugging output
- --init
- Generate initial configuration
- --full
- Print all available config options
UPDATE SUBCOMMAND
usage: freexian update [-h] [-v] [--debug]
options:
- -h, --help
- show this help message and exit
- -v, --verbose
- verbose output
- --debug
- debugging output
| July 2016 | freexian 0.1 |