https://github.com/vicentedpsantos/faktur
https://github.com/vicentedpsantos/faktur
cli invoice-generator ruby
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/vicentedpsantos/faktur
- Owner: vicentedpsantos
- License: mit
- Created: 2024-12-12T17:24:18.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-14T17:20:13.000Z (over 1 year ago)
- Last Synced: 2025-10-27T05:40:19.754Z (8 months ago)
- Topics: cli, invoice-generator, ruby
- Language: Ruby
- Homepage:
- Size: 66.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Faktur
Faktur is a simple CLI tool to generate invoices.
## Installation
To install Faktur, follow these steps:
1. Clone the repository:
```sh
git clone https://github.com/vicentedpsantos/faktur.git
```
2. Navigate to the project directory:
```sh
cd faktur
```
3. Install the necessary dependencies:
```sh
make install
```
4. To uninstall Faktur, run the following command:
```sh
make uninstall
```
## Usage
Faktur provides several commands to manage configurations and invoices. All flags are optional, and the user can run the commands without any flags.
### Configuration Commands
- **Create a new configuration:**
```sh
faktur configurations create
```
- **List all configurations:**
```sh
faktur configurations list
```
- **Delete a configuration:**
```sh
faktur configurations delete
```
- **Show a specific configuration:**
```sh
faktur configurations show
```
### Invoice Commands
- **Create a new invoice:**
```sh
faktur invoices create --number=
```
- **List all invoices:**
```sh
faktur invoices list
```
- **Delete an invoice:**
```sh
faktur invoices delete
```
- **Print an invoice:**
```sh
faktur invoices print
```
## Examples
- Create a new configuration named "default":
```sh
faktur configurations create default
```
- Create a new invoice with a specific number:
```sh
faktur invoices create --number=12345
```
## Contributing
Contributions are welcome! Please open an issue or submit a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.