{"id":20934583,"url":"https://github.com/erudika/para-cli","last_synced_at":"2025-05-13T20:31:27.965Z","repository":{"id":13805636,"uuid":"75003668","full_name":"Erudika/para-cli","owner":"Erudika","description":"CLI tool for interacting with Para servers","archived":false,"fork":false,"pushed_at":"2025-05-03T11:53:00.000Z","size":1443,"stargazers_count":6,"open_issues_count":5,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-05-03T11:55:12.237Z","etag":null,"topics":["backend","backend-as-a-service","backend-services","cli","cli-app","cli-client","cli-utilities","para"],"latest_commit_sha":null,"homepage":"https://paraio.org","language":"JavaScript","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/Erudika.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-11-28T18:46:18.000Z","updated_at":"2025-05-03T11:53:03.000Z","dependencies_parsed_at":"2024-11-18T22:09:59.677Z","dependency_job_id":"9d29c053-2d1a-45f5-982d-2e86849d8adb","html_url":"https://github.com/Erudika/para-cli","commit_stats":{"total_commits":119,"total_committers":2,"mean_commits":59.5,"dds":0.08403361344537819,"last_synced_commit":"d7146bcd91e94b030b8b90cbcf3a9986c543f8c4"},"previous_names":[],"tags_count":60,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Erudika%2Fpara-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Erudika%2Fpara-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Erudika%2Fpara-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Erudika%2Fpara-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Erudika","download_url":"https://codeload.github.com/Erudika/para-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254020903,"owners_count":22000806,"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":["backend","backend-as-a-service","backend-services","cli","cli-app","cli-client","cli-utilities","para"],"created_at":"2024-11-18T22:09:53.254Z","updated_at":"2025-05-13T20:31:27.646Z","avatar_url":"https://github.com/Erudika.png","language":"JavaScript","readme":"![Logo](https://s3-eu-west-1.amazonaws.com/org.paraio/para.png)\n\n# Para Command-Line Interface (CLI)\n\n[![NPM version][npm-image]][npm-url]\n[![Join the chat at https://gitter.im/Erudika/para](https://badges.gitter.im/Erudika/para.svg)](https://gitter.im/Erudika/para?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\n## What is this?\n\n**Para** was designed as a simple and modular backend framework for object persistence and retrieval.\nIt helps you build applications faster by taking care of the backend. It works on three levels -\nobjects are stored in a NoSQL data store or any old relational database, then automatically indexed\nby a search engine and finally, cached.\n\nThis is the command-line tool for interacting with a Para server.\n\n## Installation\n\n```sh\nnpm install -g para-cli\npara-cli setup\npara-cli ping\n```\n\n## Usage\n\n```\n                                 ________    ____\n      ____  ____ __________ _   / ____/ /   /  _/\n     / __ \\/ __ `/ ___/ __ `/  / /   / /    / /\n    / /_/ / /_/ / /  / /_/ /  / /___/ /____/ /\n   / .___/\\__,_/_/   \\__,_/   \\____/_____/___/\n  /_/\n\n  Command-line tool for Para backend servers\n\n  Usage:\n\t  $ para-cli [command] [file]\n\n\tCommands:\n\t  setup                                  Initial setup, prompts you to enter your Para API keys and endpoint\n\t  apps                                   Returns a list of all Para apps\n\t  select \u003cappid\u003e                         Selects a Para app as a target for all subsequent read/write requests.\n\t  endpoints [add|remove]                 List and select Para server endpoints, add new or remove an exiting one.\n\t  create \u003cfile|glob\u003e [--id] [--type]     Persists files as Para objects and makes them searchable\n\t  read --id 123 [--id 345 ...]           Fetches objects with the given ids\n\t  update \u003cfile.json|glob\u003e ...            Updates Para objects with the data from a JSON file (must contain id field)\n\t  delete [glob] --id 123 ...             Deletes one or more objects from Para\n\t  search \"query\" [--limit --page --sort] Searches the Para index for objects given a query string\n\t  rebuild-index                          Rebuilds the entire search index\n\t  app-settings                           Returns all settings for the authenticated app\n\t  new-key                                Generates a new secret key and saves it to config.json\n\t  new-jwt                                Generates a new JWT super token to be used for app authentication\n\t  new-app \u003cname\u003e --name --shared         Creates a new Para app. Only works if you have the keys for the \"root\" app\n\t  delete-app \u003cid\u003e                        Deletes an existing Para app. Only works for child apps, not the \"root\" app\n\t  export                                 Exports all data from the app's table\n\t  import \u003cfile\u003e                          Imports data from a previously exported ZIP archive\n\t  ping                                   Tests the connection to the Para server\n\t  me                                     Returns the JSON for the currently authenticated user or app\n\n\tOptions:\n\t  --type          Sets the \"type\" field of an object\n\t  --id            Sets the \"id\" field of an object\n\t  --sanitize      Strips all symbols from input files\n\t  --accessKey     Sets the Para access key\n\t  --secretKey     Sets the Para secret key\n\t  --endpoint      Sets the URL of the Para server\n\t  --sort          Sets the field on which to sort search results\n\t  --desc          Descending sort for search results (default: true)\n\t  --page          Page number for search results, \"all\" will auto-paginate through all results\n\t  --limit         Limits the number of search results\n\t  --lastKey       Sets the last id for search-after pagination\n\t  --cwd           Sets the current directory - used for resolving file paths\n\t  --encodeId      By default all ids are Base64 encoded, unless this is 'false'\n\t  --help          Prints the list of commands\n\t  --version       Prints the version of the program\n\n\tExamples:\n\t  $ para-cli setup\n\t  $ para-cli create my-blog-post.md\n\t  $ para-cli read --id my-blog-post.md\n\t  $ para-cli create index.html --type webpage --id \"My new article\" --sanitize\n\t  $ para-cli delete --id 123 --id \"my-blog-post.md\"\n\t  $ para-cli search \"type:article AND title:*\" --sort timestamp --desc false --limit 10\n\t  $ para-cli search \"*\" --type article --page all\n\t  $ para-cli new-key\n\t  $ para-cli new-app \"mynewapp\" --name \"Full app name\"\n\t  $ para-cli apps\n\t  $ para-cli select scoold\n\t  $ para-cli endpoints\n\n```\n\nThe tool supports basic CRUD operations on files and can also generate JWT 'super tokens' or new secret keys for your app.\nYou can use the CLI to upload multiple files, like blog posts, for example. The files can be HTML, text or JSON.\n\nThe plan is to add more functionality in the near future.\n\n## Configuration\n\n**Quick start:**\n```\npara-cli setup\n```\n\nThe configuration file is located in `~/.config/para-cli-nodejs/config.json` and contains the keys used to authenticate\nwith a Para server. The properties `accessKey`, `secretKey` and `endpoint` can be passed as arguments or loaded from the\nconfig file. Also you can choose to set the environment variables `PARA_ACCESS_KEY`, `PARA_SECRET_KEY` and `PARA_ENDPOINT`.\nThe command-line arguments take precedence over environment variables, and if those are missing we read from `config.json`.\n\nHere's an example `config.json` file:\n```\n{\n  \"accessKey\": \"app:para\",\n  \"secretKey\": \"abc231234ufnX85123o1few==\",\n  \"endpoint\": \"http://localhost:8080\"\n}\n```\n\nOnce configured you can test your connection to the server:\n\n```\npara-cli ping\n```\n\nTo get the currently authenticated app/user object run:\n```\npara-cli me\n```\n\n## Switching between apps and endpoints\n\nPara CLI can be configured to work with multiple Para servers and apps. Here's how to add additional Para server endpoints:\n```\npara-cli endpoints add\n```\nTo select a specific endpoint run:\n```\npara-cli endpoints\n```\n\nAfter selecting the Para server you wish to connect to, you can list and select apps within it:\n```\npara-cli apps\n```\nSelect the 'scoold' app, for example:\n```\npara-cli select scoold\n```\n\n## Para Docs\n\n### [Read the Docs](https://paraio.org/docs)\n\n## Contributing\n\n1. Fork this repository and clone the fork to your machine\n2. Create a branch (`git checkout -b my-new-feature`)\n3. Implement a new feature or fix a bug and add some tests\n4. Commit your changes (`git commit -am 'Added a new feature'`)\n5. Push the branch to **your fork** on GitHub (`git push origin my-new-feature`)\n6. Create new Pull Request from your fork\n\nFor more information see [CONTRIBUTING.md](https://github.com/Erudika/para/blob/master/CONTRIBUTING.md)\n\n## License\n[Apache 2.0](LICENSE)\n\n\n[npm-image]: https://badge.fury.io/js/para-cli.svg\n[npm-url]: https://npmjs.org/package/para-cli\n[travis-image]: https://travis-ci.org/Erudika/para-cli.svg?branch=master\n[travis-url]: https://travis-ci.org/Erudika/para-cli\n[daviddm-image]: https://david-dm.org/Erudika/para-cli.svg?theme=shields.io\n[daviddm-url]: https://david-dm.org/Erudika/para-cli\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferudika%2Fpara-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ferudika%2Fpara-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferudika%2Fpara-cli/lists"}