Command Line Interface

Get the damas command and make it executable:

chmod +x damas

You can directly use it without installing it system-wide. To install the command on your system (optional):

sudo cp damas /usr/bin

Manual page

NAME
  damas - a command line interface to access a remote damas-core storage

SYNOPSIS
  damas [OPTION...] <COMMAND> [<ARGS>]
  damas [--help] [-s|--server <server_url>] [-q|--quiet] [-v|--verbose] [-l|--lines] [--apikey <DAMAS_TOKEN>] <COMMAND> [<ARGS>]

DESCRIPTION
  cURL-based command to expose the operations of a damas-core service.

  When ARGS is -, read standard input.

COMMANDS
  Authentication commands:
     signin    <username> <pass> [<lifespan>] or without arguments for interactive sign in
     signout   Remove authorization token

  CRUDS commands (send JSON to the server, see examples below):
     create       <json>  insert object(s)
     read         <json>  retrieve object(s) keys
     update       <json>  modify object(s) keys
     upsert       <json>  insert and modify object(s)
     delete       <json>  delete object(s)

  MORE commands
     graph        <json>  retrieve related nodes and edges
     search       <query> search by query string
     search_mongo <mongo_query> <sort> <limit> <skip> MongoDB search

ENVIRONMENT VARIABLES
  DAMAS_SERVER
    URL of the server hosting damas-core. It can specify `https://` or `http://` protocols.
  DAMAS_TOKEN
    Token used for authentication.

EXAMPLES
  insert an arbitrary object giving a JSON"
      damas -s yourserver create '{\"key\":\"value\",\"comment\":\"created with cli\"}'"
  list every objects"
      damas -s yourserver search *"
  retrieve an object
      damas -s yourserver read '"object_id"'
  retrieve multiple objects
      damas -s yourserver read '["object_id1","object_id2"]'
  search keys matching a regular expression"
      damas -s yourserver search _id:/.*mov/"
  read objects from a search result using a pipe"
      damas search * | damas read -"
  search deleted:true key, sort by _id key, show result as lines of ids"
      damas -s yourserver -l search_mongo '{\"deleted\":true}' '{\"_id\":1}' 0 0"

EXIT VALUES
  0  Success
  1  Syntax or usage error
  2  Not a damas repository (or any parent)
  3  Server is unreachable
  7  (Server 207) Multi-Status (some objects do not exist)
  40 (Server 400) Bad request (not formatted correctly)
  41 (Server 401) Unauthorized
  43 (Server 403) Forbidden (the user does not have the right permission)
  44 (Server 404) Not found (all objects do not exist)
  49 (Server 409) Conflict (all objects already exist with these identifiers)
  50 (Server 500) Internal server error
  60 (Server xxx) Unknown server error

FILES
  /tmp/damas-<username>-<signature> tokens issued at signin

CREDITS
    damas.sh part of damas-core and is distributed under the GNU General Public License.
    See the file LICENSE for details.

AUTHOR
    damas.sh was originally written by Thibault Allard and is maintained by Remy Lalanne.