{"id":26145004,"url":"https://github.com/orphic-inc/ruby-orphic-cli","last_synced_at":"2025-04-14T02:35:33.523Z","repository":{"id":54837288,"uuid":"308664937","full_name":"orphic-inc/ruby-orphic-cli","owner":"orphic-inc","description":"This CLI provides interfaces and instruments of implementing plumbing between Ruby, RoR, Node, and Golang.","archived":false,"fork":false,"pushed_at":"2023-03-18T20:15:34.000Z","size":524,"stargazers_count":3,"open_issues_count":5,"forks_count":3,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-05T19:51:28.461Z","etag":null,"topics":["cli","hacktoberfest","ruby"],"latest_commit_sha":null,"homepage":"https://orphic.enterprises/orphic-cli","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/orphic-inc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-30T15:07:18.000Z","updated_at":"2024-02-15T05:57:45.000Z","dependencies_parsed_at":"2022-08-14T04:20:30.385Z","dependency_job_id":null,"html_url":"https://github.com/orphic-inc/ruby-orphic-cli","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/orphic-inc%2Fruby-orphic-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orphic-inc%2Fruby-orphic-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orphic-inc%2Fruby-orphic-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orphic-inc%2Fruby-orphic-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/orphic-inc","download_url":"https://codeload.github.com/orphic-inc/ruby-orphic-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248497891,"owners_count":21113983,"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","hacktoberfest","ruby"],"created_at":"2025-03-11T04:25:21.785Z","updated_at":"2025-04-14T02:35:33.495Z","avatar_url":"https://github.com/orphic-inc.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Info\n\n[![Gem Version](https://badge.fury.io/rb/orphic.svg)](https://badge.fury.io/rb/orphic)\n\n## Installation\n\nYou'll need [Ruby](https://www.ruby-lang.org/en/documentation/installation/) and Rubygems installed for the Ruby Orphic CLI to function and develop your own commands or plugins. This is built using the [Thor toolkit (Insecure Link!)](http://whatisthor.com/), [RSpec](https://rspec.info/documentation/), and other commonly found gems in Ruby CLIs. Inspired by [this video](https://www.youtube.com/watch?v=1ILEw6Qca3U). If `npm --version` runs in your console, you can also connect the Ruby CLI with our [Node.JS CLI](https://github.com/orphic-inc/node-orphic-cli) [_Editor's Note_: Future state]. To learn more about Rubygems see the [Rubygems.org API](https://guides.rubygems.org/rubygems-org-api/) for more info on accessing various `gem` functionalities.\n\n### Front End Development \n\n[Follow these steps](https://github.com/slatedocs/slate/wiki/Using-Slate-Natively) to run Slate for Front-end of orphicoin.com. //TODO connect CLI to front-end.\n\n#### `neo` Windows Quick-Start Mini-Guide\n\n- [Install Windows 10](https://www.microsoft.com/en-us/software-download/windows10)\n\n- [Install Google Chrome](https://google.com/chrome)\n\n- [(DEV) Install Canary](https://google.com/chrome/canary)\n\n- (DEV) Install [Sublime Text](https://www.sublimetext.com/) AND/OR [VS Code](https://code.visualstudio.com/download) + git extensions\n\n- [Install WSL2](https://docs.microsoft.com/en-us/windows/wsl/install-win10)\n\n### Developer Installation\n\nOnce the steps above are complete, you'll need the Bundler Ruby gem to locally bundle any changes made with `gem install bundler`. For more on [Bundler](https://bundler.io/) and Gemfiles, check out the [bundler docs here](https://bundler.io/gemfile.html). To build from source, clone the repo, access the directory and run `bundle install`. **We strongly recommend using version control before continuing further.** You can clone the ruby-orphic-cli repository into your own and once your changes are complete, they can be submitted for review via a Pull Request. If unfamiliar with git, Orphic recommends [Git SCM](https://git-scm.com/). \n\nIt is highly recommended to use macOS or Linux as a base operating system when developing on our CLI in its current state. **Windows Linux Subsystem 2 requires sudo for most functions**\n\n## Common Errors\n\n[```Permission denied when installing bundler```](https://bundler.io/doc/troubleshooting.html)\n[```Development tools error```](https://stackoverflow.com/a/63442072/9281567)\n\n`sudo apt-get install ubuntu-dev-tools`\n\n### Getting Started\n\nThe Orphic CLI runs on both Ruby and NodeJS, and to get started with either we recommend using [Brew](https://brew.sh) on Linux and Unix distros (including macOS), or [Chocolatey](https://chocolatey.org/) for Windows users. The CLI is currently focused on *-nix* developer environments. With these package managers you can install [nvm](https://github.com/nvm-sh/nvm) and [rbenv](https://github.com/rbenv/rbenv): version management software that will create environments for any specified version. On -nix variants, we recommend against using such package managers for installing nvm as it should be manually installed ([explained](https://stackoverflow.com/a/41913355/9281567)).\n\nOn Windows you'll need to install [Windows Subsystem Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10) ([“¯_(ツ)_//¯“](https://gorails.com/setup/windows/10)).\nv2 will focus on Windows PowerShell shortcuts via Chocolatey ([Soon! If you'd like to create a Chocolatey pluj for us, see this!](https://chocolatey.org/packages/travis)).\n\nWe recommend Ruby version 2.7.1 and Node version 12 or 14. [Google is your friend](https://lmgtfy.com/?q=install+ruby+and+rubygems), and this is a [good article for macOS users](https://www.moncefbelyamani.com/the-definitive-guide-to-installing-ruby-gems-on-a-mac/) - ([Ubuntu/WSL](https://stackify.com/install-ruby-on-ubuntu-everything-you-need-to-get-going/)). If those steps are complete, you can install the gem locally with `gem install orphic`.\n\nUse of either the Ruby or NodeJS CLIs can be independent, for more complex applications use of both leads to more succinct solutions when justified. These features are currently in progress and documentation will be noted here when available. V2 will incorporate the rails gem as a means of deploying NodeJS/Docker containers.\n\n## macOS\n\nmacOS includes a version of ruby and for that reason Orphic recommends using shims via rbenv to maintain a separate development environment. Our codebase is on Ruby 2.7.2, so your mileage may vary, but feel free to submit an Issue for any unexpected outcomes with replicable steps to anticipate the same conclusion. \n\n# Example `neo` commands:\n\n## orphic help\n\n[This will help you get started developing new commands with thor](https://github.com/rails/thor/wiki), there are currently these commands and subcommands available:\n\n```\nhello\n -Uppercase -- Uppercase flag\nnode\n  node hello\n  node help\n   -tags -- tags option\n   Command -- (req.) argument\n  node deploy\n   -Site -- Site flag\n   -baseDistrict -- argument\nmap -- view map commands\n  map \n    -createDistrict\n  map \n    -viewDistrict\n  map\n    -Spools\nmedia\n    -TYPE -- Type flag\nSpools\n  Paji\n    posPaji\n    update_Paji\n  Cursor\n    posCursor\n    GeekCursor\n    mongoDb\n     mongo_URL - (req.) argument\n  Geek\n    Data\n  Flash\n    require Geek\n    puts \"hi from flash\"\n```\n\n# Example dev commands:\n\n## `bundle exec exe/orphic help`\n\n## Publishing the Ruby gem\n\n[Start with this doc](https://guides.rubygems.org/publishing/) and [your own test ruby gem](https://guides.rubygems.org/make-your-own-gem/#documenting-your-code), you can copy an [early branch if you'd like](https://rubygems.org/gems/orphic/versions/0.1.0).\n\nThis will help you get started:\n`nano lib/orphic/version.rb`\n`rm *i*`\n`bundler install`\n`gem build`\n`gem publish *i*`\n\n## Git\n\n## Example baseDistricts\n\nCreate a new branch with git to something like `git branch`.\n\n## Example HTTP headers\n```\nRequest headers\nX-Forwarded-For: {IP address}\nCache-control: no-cache\nAuthorization: {auth token}\nUser-Agent: {your custom user agent}\nResponse headers\nAccess-Control-Allow-Origin: *\nX-Frame-Options: deny\n```\n\n### git status\n### git push\n### git push -u origin main\n\n\n### Next Steps:\n\n# 1.0.0 \n## Integrate [Node.JS Orphic CLI](https://github.com/orphic-inc/node-orphic-cli)\n\n### Finish diagramming / roadmapping\n\n# 1.5.0\n## Integrate gCloud CLI APIs \u0026 Billing APIs // \u0026/|| GitHub / Vercel/ZEIT.CO APIs / GHActions and/or GHPages.\n\n### Integrate Blockchain \u0026\u0026\\/|| additional necessary APIs to handle off-load advanced (and/or atypical) reciprocal calling.\n## [Cursor](https://github.com/orphic-inc/cardano-meta-handler)\n## [Paji]((https://github.com/orphic-inc/serial)\n## [https://github.com/orphic-inc/ACNHMobileSpawner](Geek)\n## [Sprite](https://github.com/orphic-inc/reach-wager)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forphic-inc%2Fruby-orphic-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Forphic-inc%2Fruby-orphic-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forphic-inc%2Fruby-orphic-cli/lists"}