Skip to content
This repository has been archived by the owner on Nov 30, 2023. It is now read-only.

gini/gapicmd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gapicmd

Build Status Download latest release

Command line client to interact with Gini's API service.

NAME:
   gapicmd - interact with Gini's API service from the command line

USAGE:
   ./gapicmd [global options] command [command options] [arguments...]

VERSION:
   0.9.46

AUTHOR(S):
   Daniel Kerwin @dkerwin

COMMANDS:
   upload, u           upload a new document
   get, g              get document details
   get-extractions, e  get document extractions and candidates
   get-processed, p    get processed document
   delete, d           delete a document
   list, l             list a user's documents
   report, r           submit an error report
   help, h             Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --curl, -c          Show curl command to replay
   --debug, -d         Show HTTP requests and responses
   --no-color, -n      Disable colorized output
   --client-id         Gini API client ID [$CLIENT_ID]
   --client-secret     Gini API client secret [$CLIENT_SECRET]
   --user-id           Random user identfier string #freestyle [$USER_ID]
   --help, -h          show help
   --version, -v       print the version

COPYRIGHT:
   2015 - Gini GmbH

Supported platforms

  • darwin/amd64
  • linux/amd64
  • windows/amd64 (experimental, absolutely no guarantee)

Security

gapicmd can operate with builtin default credentials to give you a smooth start. This convinience function could have a possible downside for you. In theory another user could access your documents if he/she knew your user-id. This is unlikly but it's important for you to understand the possible risks.

If you don't set a user ID (--user-id) gapicmd will generate a random string everytime you run gapicmd. Here's how a autogenerated user-id looks: xZhXUpvh5-46gYLU=6pEZj-1RdF9kwg3K2kB7V.-s8N3RDPp4K28-FdOffSmDNK6.

If you want to be on the safe side get in contact to get your personal Gini client credentials.

Documents uploaded by the shared user-id are removed automatically after a couple of days.

License

The MIT License (MIT)

Copyright (c) 2015 Gini GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

About

Multi platform command line client to interact with Gini's API service

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages