{"id":20039647,"url":"https://github.com/bamarni/ticketfile","last_synced_at":"2025-05-05T07:32:44.077Z","repository":{"id":57526148,"uuid":"52212108","full_name":"bamarni/ticketfile","owner":"bamarni","description":"Receipts for humans","archived":false,"fork":false,"pushed_at":"2017-01-03T12:05:41.000Z","size":866,"stargazers_count":15,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-08T19:22:45.575Z","etag":null,"topics":["epson","escpos","golang","pos","receipt","template-engine","thermal-printer","thermal-printing"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bamarni.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-02-21T15:10:07.000Z","updated_at":"2023-05-09T02:30:11.000Z","dependencies_parsed_at":"2022-09-07T05:30:36.683Z","dependency_job_id":null,"html_url":"https://github.com/bamarni/ticketfile","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bamarni%2Fticketfile","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bamarni%2Fticketfile/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bamarni%2Fticketfile/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bamarni%2Fticketfile/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bamarni","download_url":"https://codeload.github.com/bamarni/ticketfile/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252458617,"owners_count":21751074,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["epson","escpos","golang","pos","receipt","template-engine","thermal-printer","thermal-printing"],"created_at":"2024-11-13T10:38:32.353Z","updated_at":"2025-05-05T07:32:43.703Z","avatar_url":"https://github.com/bamarni.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ticketfile [![Build Status](https://travis-ci.org/bamarni/ticketfile.svg?branch=master)](https://travis-ci.org/bamarni/ticketfile)\n\n- [What is a Ticketfile?](#what-is-a-ticketfile)\n- [Why would I use Ticketfiles?](#why-would-i-use-ticketfiles)\n- [Ticketfile specification](#ticketfile-specification)\n- [Golang library usage](#golang-library-usage)\n- [Contributing](#contributing)\n\n## What is a Ticketfile?\n\nA Ticketfile is a textual representation of a thermal printer receipt.\n\nIt allows you to write simple readable text for your receipts rather than having to deal for example with\n[ESC/POS](http://content.epson.de/fileadmin/content/files/RSD/downloads/escpos.pdf)\nspecification directly.\n\n## Why would I use Ticketfiles?\n\nMaybe you've found an ESC/POS library for your favorite language out there\nand you're wondering why you should use Ticketfiles instead?\n\nEven though they're inspired by ESC/POS specification, Ticketfiles are human-readable \n([here is a Ticketfile](tests/functional/fixtures/Ticketfile) and its [ESC/POS equivalent](tests/functional/fixtures/Ticketfile.expected)) and **manufacturer agnostic**.\nIn the future if a new standard emerges we'll do our best to support it without changing the spec in a breaking way. \n\nIf you use a library you'll also be tied to a language, Ticketfiles are **language agnostic**, it's just text. \nThey can easily be generated through any language and templating engine.\n\nFinally, even though they mainly target receipt printers, Ticketfiles are **context agnostic**.\nFor instance, our Golang library also provides an HTML converter so that a Ticketfile can be displayed in a browser or sent as e-mail attachment.\n\n## Ticketfile specification\n\nFull specification are available [here](spec/spec.md).\n\n## Golang library usage\n\nThe Golang library contains a parser and various converters.\n\nThe most simple way to use it is through the `ticket` command :\n\n    go get -u github.com/bamarni/ticketfile/cmd/ticket\n\nThe following command would then convert a Ticketfile into ESC/POS commands and send them to a printer :\n\n    ticket \u003c /path/to/ticketfile \u003e /path/to/device\n\n*In case of a syntax error in your ticketfile, a message would be displayed to stderr while nothing would be sent to the printer device.*\n\nTo convert your Ticketfile into HTML :\n\n    ticket -html \u003c /path/to/ticketfile \u003e receipt.html\n\n## Contributing\n\nContributions and new ideas are always welcome.\n\nThe Golang library is a first-class citizen so any change in the specification needs to be reflected in the Go engine. \n\nReleased under the MIT license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbamarni%2Fticketfile","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbamarni%2Fticketfile","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbamarni%2Fticketfile/lists"}