{"id":14037146,"url":"https://github.com/summera/retscli","last_synced_at":"2025-07-27T05:30:32.018Z","repository":{"id":47489195,"uuid":"56021609","full_name":"summera/retscli","owner":"summera","description":"CLI for querying RETS servers and searching metadata.","archived":false,"fork":false,"pushed_at":"2023-05-24T19:49:26.000Z","size":29,"stargazers_count":57,"open_issues_count":2,"forks_count":8,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-11-09T05:46:11.081Z","etag":null,"topics":["cli","command-line","mls","real-estate","rets"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/summera.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-04-12T01:44:51.000Z","updated_at":"2023-09-07T00:49:37.000Z","dependencies_parsed_at":"2022-09-18T04:52:18.840Z","dependency_job_id":null,"html_url":"https://github.com/summera/retscli","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/summera%2Fretscli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/summera%2Fretscli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/summera%2Fretscli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/summera%2Fretscli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/summera","download_url":"https://codeload.github.com/summera/retscli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227762519,"owners_count":17816035,"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":["cli","command-line","mls","real-estate","rets"],"created_at":"2024-08-12T03:02:31.541Z","updated_at":"2024-12-02T16:32:05.086Z","avatar_url":"https://github.com/summera.png","language":"Ruby","funding_links":[],"categories":["Ruby"],"sub_categories":[],"readme":"# retscli\n\n[![Gem Version](https://badge.fury.io/rb/retscli.svg)](https://badge.fury.io/rb/retscli)\n[![Build Status](https://travis-ci.org/summera/retscli.svg?branch=master)](https://travis-ci.org/summera/retscli)\n\nCLI for querying RETS servers and searching metadata.\n\nThis gem is built on top of the [rets](http://github.com/estately/rets) gem, which handles the actual querying and parsing of the RETS server requests. Big thanks to the [Estately](http://www.estately.com) team for their work!\n\n![retscli gif](https://github.com/summera/gifs/blob/master/retscli/search_metadata_cropped.gif?raw=true)\n![retscli png](https://github.com/summera/gifs/blob/master/retscli/search.png?raw=true)\n\n## Installation\n    $ gem install retscli\n\n## Features\n- Search metadata for keywords. Results are highlighted for readability.\n- Search resources. Results are displayed in a nicely formatted ascii table.\n- Open command results in your editor of choice.\n- Debug RETS requests and queries in debug mode.\n- Command results are paged using less by default.\n\n## Usage\n\n#### CLI Commands\n```bash\n$ retscli help\nCommands:\n  retscli capabilities [LOGIN URL]  # Display capabilities for rets server\n  retscli console [LOGIN URL]       # Start rets console\n  retscli help [COMMAND]            # Describe available commands or one specific command\n  retscli validate [LOGIN URL]      # Validate rets credentials\n```\n\nTo see the available flags/options, run help on the command\n\n```bash\n$ retscli help console\nUsage:\n  retscli console [LOGIN URL]\n\nOptions:\n  -u, [--username=USERNAME]        # Username\n  -p, [--password=PASSWORD]        # Password\n  -v, [--version=VERSION]          # Rets version\n                                   # Default: RETS/1.7.2\n  -a, [--agent=AGENT]              # User agent\n  -t, [--ua-password=UA_PASSWORD]  # User agent password\n  -d, [--debug], [--no-debug]      # Debug mode\n\nStart rets console\n```\n\n#### Debug Mode\nTo view requests being made to the RETS server, enable debug mode with the `-d` flag. Once enabled, helpful info will be logged to `$stdout`. This is helpful to debug errors thrown by the RETS server and to adjust queries.\n\n#### Rets Console Commands\nAfter dropping into the RETS console, you get a bunch of useful commands for searching and exploring the RETS server\n\n```bash\n$ retscli console http://rets.server.com -u summera -p password\n\nsummera@rets.server.com \u003e help\nCommands:\n  capabilities                       # Display capabilities for rets server\n  classes [RESOURCE]                 # List available classes for resource\n  help [COMMAND]                     # Describe available commands or one specific command\n  login                              # Re-Login to RETS server. Use if session is no longer valid\n  metadata                           # View metadata\n  objects [RESOURCE]                 # List available objects for resource\n  resources                          # List available resources\n  search [RESOURCE] [CLASS] [QUERY]  # Search resources, e.g. properties, open houses, etc.\n  search-metadata                    # Search metadata tables\n  tables [RESOURCE] [CLASS]          # List available tables for class of resource\n  timezone-offset                    # System timezone offset\n```\n\nAgain, to see available flags/options, run help on the command. Many of the commands have an `editor` option if you feel the need to get down and dirty in your editor of choice.\n\n\n```bash\nsummera@rets.server.com \u003e help search-metadata\nUsage:\n  search-metadata\n\nOptions:\n  -r, [--resources=one two three]  # Filter metadata by resources\n  -c, [--classes=one two three]    # Filter metadata by classes\n  -e, [--editor=EDITOR]            # Open search results in editor\n\nSearch metadata tables\n```\n\n## Notes\n- When opening output in your editor, retscli will check the `$EDITOR` environment variable. If this is not set, it falls back to nano.\n- Much of the output is piped through `less` by default to allow for easy paging. If you'd like to change this, set your preferred pager in the `$PAGER` environment variable.\n- Retscli uses the ruby readline module for the rets console.\n- If any arguments and/or options have spaces in them, you will need to wrap them in quotes so that retscli does not split on the spaces.\n\n## Contributing\n\n1. Fork it ( https://github.com/summera/retscli/fork )\n1. Create your feature branch (`git checkout -b my-new-feature`)\n1. Commit your changes (`git commit -am 'Add some feature'`)\n1. Run the test suite (`bundle exec rake`)\n1. Push to the branch (`git push origin my-new-feature`)\n1. Create a new Pull Request\n\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsummera%2Fretscli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsummera%2Fretscli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsummera%2Fretscli/lists"}