{"id":13581731,"url":"https://github.com/stgarf/paperless-cli","last_synced_at":"2025-04-06T10:32:50.373Z","repository":{"id":35002953,"uuid":"173205328","full_name":"stgarf/paperless-cli","owner":"stgarf","description":"A golang command line binary to interact with a Paperless instance","archived":true,"fork":false,"pushed_at":"2024-01-17T16:24:06.000Z","size":6372,"stargazers_count":55,"open_issues_count":0,"forks_count":10,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-05T21:45:03.923Z","etag":null,"topics":["command-line-tool","document-management","golang","paperless","paperless-cli"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stgarf.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"stgarf","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2019-02-28T23:53:37.000Z","updated_at":"2024-03-29T12:36:48.000Z","dependencies_parsed_at":"2024-06-18T23:00:50.414Z","dependency_job_id":"6193d973-8f2a-4e04-b870-7dee0e37a898","html_url":"https://github.com/stgarf/paperless-cli","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stgarf%2Fpaperless-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stgarf%2Fpaperless-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stgarf%2Fpaperless-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stgarf%2Fpaperless-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stgarf","download_url":"https://codeload.github.com/stgarf/paperless-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247470470,"owners_count":20944146,"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":["command-line-tool","document-management","golang","paperless","paperless-cli"],"created_at":"2024-08-01T15:02:12.708Z","updated_at":"2025-04-06T10:32:47.044Z","avatar_url":"https://github.com/stgarf.png","language":"Go","funding_links":["https://github.com/sponsors/stgarf"],"categories":["Go"],"sub_categories":[],"readme":"# paperless-cli\n[![license](https://img.shields.io/badge/license-Apache%20v2-success.svg)](https://raw.githubusercontent.com/stgarf/paperless-cli/master/LICENSE)\n[![Build Status](https://travis-ci.org/stgarf/paperless-cli.svg?branch=master)](https://travis-ci.org/stgarf/paperless-cli)\n\n![badge](https://img.shields.io/badge/stargazers-over%20time-yellow)\n[![Stargazers over time](https://starchart.cc/stgarf/paperless-cli.svg)](https://starchart.cc/stgarf/paperless-cli)\n\n\n# Table of Contents\n\n- [Description](#description)\n- [Installation and Usage](#Installation-and-usage)\n  * [Prerequisites](#prerequisites)\n  * [Precompiled binary](#precompiled-binary)\n  * [Self-compiled binary](#self-compiled-binary)\n  * [Usage](#usage)\n    - [Check paperless-cli version](#check-paperless-cli-version)\n    - [Setting up a config](#setting-up-a-config)\n- [Development](#development)\n  * [Prerequisites](#prerequisites)\n  * [Get the code](#get-the-code)\n  * [Running the tests](#running-the-tests)\n- [Built With](#built-with)\n- [Contributing](#contributing)\n- [Versioning](#versioning)\n- [Authors](#authors)\n- [License](#license)\n- [Acknowledgments](#acknowledgments)\n\n\n## Description\n\nA CLI tool written in Go to interface with a [Paperless](https://github.com/the-paperless-project/paperless) instance.\n\n## Installation and usage\n\n### Prerequisites\n\nYou should have a working Go environment and have `$GOPATH/bin` in your `$PATH`.\n\n### Precompiled binary\n\nYou can get a precompiled binary from the releases page (soon).\n\n### Self-compiled binary\n\nTo download source, compile, and install, run:\n```shell\n$ go get -u github.com/stgarf/paperless-cli\n$ $GOPATH/src/github.com/stgarf/paperless-cli/build.sh\n```\n\nThe source code will be located in `$GOPATH/src/github.com/stgarf/paperless-cli`.\n\nA newly compiled binary will be in `$GOPATH/src/github.com/stgarf/paperless-cli/bin/`\n\nYou can place the binary in you `$PATH` for easy usage. e.g.\n\n`$ cp $GOPATH/src/github.com/stgarf/paperless-cli/bin/paperless-cli $GOPATH/bin`\n\n`$ which paperless-cli` should return the path to the newly installed binary.\n\n### Usage\n\n#### Check paperless-cli version\n\n```shell\n$ paperless-cli version\npaperless-cli v0.6.0 built on 2019-03-10T16:28:33Z from git:c8dd2e7-clean (master) by user@chrx\n```\n\n#### Setting up a config\n\nYou can set up a basic YAML-based configuration to be read by placing it in\n`$HOME/.paperless-cli.yaml`.\n\nA base config can be autogenerated with `paperless-cli config create`.\n\nHere's an example configuration:\n```yaml\n# A basic paperless-cli configuration file.\n\n# The hostname of the Paperless instance.\nhostname: localhost\n# Connect via HTTP or HTTPS.\nuse_https: false\n# Port the Paperless instance is listening on.\nport: 8000\n# Path to the API root.\nroot: /api\n# Username to auth to Paperless instance.\nusername: myUsername\n# Username to auth to Paperless instance.\npassword: mYpa$$w0rd.is.h0p3fully.s3cur3!!1\n```\n## Development\n\n### Prerequisites\n\nYou should have a working Go environment and have `$GOPATH/bin` in your `$PATH`.\n\n### Get the code\n\nTo download the source code, run:\n```shell\n$ go get -du github.com/stgarf/paperless-cli\n```\n\nThe source code will be located in `$GOPATH/src/github.com/stgarf/paperless-cli`.\n\n### Running the tests\n\n`$ go test`\n\nReally though, there are none and need to be written.\n\n## Built With\n\n* [cobra](https://github.com/spf13/cobra) - A Commander for modern Go CLI interactions\n* [logrus](https://github.com/sirupsen/logrus) - Structured, pluggable logging for Go\n* [gjson](https://github.com/tidwall/gjson) - Get JSON values quickly - JSON Parser for Go\n* [viper](https://github.com/spf13/viper) - Go configuration with fangs\n* [go-fqdn](https://github.com/Showmax/go-fqdn) - Simple wrapper around net and os golang standard libraries providing Fully Qualified Domain Name of the machine\n* [go-homedir](https://github.com/mitchellh/go-homedir) - Go library for detecting and expanding the user's home directory without cgo\n* [govvv](https://github.com/ahmetb/govvv) - \"go build\" wrapper to add version info to Golang applications\n\n## Contributing\n\nPlease read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the code of conduct, and the process for submitting pull requests to the project.\n\n## Versioning\n\nWe use [SemVer](https://semver.org/) for versioning, roughly. For the versions available, see the [tags on this repository](https://github.com/stgarf/paperless-cli/tags).\n\n## Authors\n\n* **Steve Garf** - *Initial CLI work* - [stgarf](https://github.com/stgarf)\n* **Zibby Mofrad** - *Document Download option* - [zibby](https://github.com/zibby)\n\nSee also the list of [contributors](https://github.com/stgarf/paperless-cli/contributors) who participated in this project.\n\n## License\n\nThis project is licensed under the Apache License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\n* [Daniel Quinn](https://github.com/danielquinn) for starting Paperless and the awesome community of people maintaining [Paperless](https://github.com/the-paperless-project/paperless)\n* Seth Junot for rubber duck debugging - [xSetech](https://github.com/xSetech)\n* Hat tip to anyone whose code was imported!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstgarf%2Fpaperless-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstgarf%2Fpaperless-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstgarf%2Fpaperless-cli/lists"}