{"id":23047408,"url":"https://github.com/moceanapi/mocean-cli","last_synced_at":"2026-04-28T20:06:39.389Z","repository":{"id":48314090,"uuid":"142421942","full_name":"MoceanAPI/mocean-cli","owner":"MoceanAPI","description":"✉📲 SDK Library for Node CLI to send SMS for FREE using MoceanAPI sms solution.","archived":false,"fork":false,"pushed_at":"2021-08-02T05:42:16.000Z","size":33,"stargazers_count":0,"open_issues_count":6,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-30T09:48:52.567Z","etag":null,"topics":["moceanapi","node-cli","nodejs","sms","sms-client","sms-messages"],"latest_commit_sha":null,"homepage":"https://moceanapi.com/","language":"JavaScript","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/MoceanAPI.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}},"created_at":"2018-07-26T09:51:40.000Z","updated_at":"2020-07-30T12:55:34.000Z","dependencies_parsed_at":"2022-08-26T20:24:40.957Z","dependency_job_id":null,"html_url":"https://github.com/MoceanAPI/mocean-cli","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MoceanAPI%2Fmocean-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MoceanAPI%2Fmocean-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MoceanAPI%2Fmocean-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MoceanAPI%2Fmocean-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MoceanAPI","download_url":"https://codeload.github.com/MoceanAPI/mocean-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246927807,"owners_count":20856193,"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":["moceanapi","node-cli","nodejs","sms","sms-client","sms-messages"],"created_at":"2024-12-15T22:33:29.612Z","updated_at":"2026-04-28T20:06:39.320Z","avatar_url":"https://github.com/MoceanAPI.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Mocean CLI\n============================\n\nThis is the powerful CLI program for use with Mocean's API. To use this, you'll need a Mocean account. Sign up [for free at \nmoceanapi.com][signup].\n\n * [Installation](#installation)\n * [Example](#example)\n * [Options](#options) \n \n## Installation\n\n### Pre-requisite\nMocean-CLI is powered by NodeJS, so you will need first to install [NodeJS](https://nodejs.org/en/) and [npm](https://www.npmjs.com/\n), before proceed to use Mocean-CLI.\n\n### Install mocean-cli \n\nTo use the client library you'll need to have [created a Mocean account][signup]. \n\nTo install the Node CLI client library using [npm](https://www.npmjs.com/).\n\n```bash\nnpm i mocean-cli -g\n```\n\n### Usage\n\nAfter installation, login to the cli with your credentials\n\n```bash\n\u003e mocean login \u003capi_key\u003e \u003capi_secret\u003e\n```\n\nThis will save your credentials to `~/.moceanrc`.  \nAdd `--local` to save it in the directory which running the command\n\n```bash\n\u003e mocean login \u003capi_key\u003e \u003capi_secret\u003e --local\n```\n\nRun `mocean logout` if you want to clear the credentials, this is strongly encouraged when running on untrusted device \n\n```bash\n\u003e mocean logout\n```\n\nTo logout from the directory, add `--local`\n\n```bash\n\u003e mocean logout --local\n```\n\n### Account\n\n#### Account Info\n\n```bash\n\u003e mocean account\n```\n\nAlias : `mocean acc`\n\n#### Account Balance\n\n```bash\n\u003e mocean account:balance\n```\n\nAlias : `mocean ab`\n\n#### Account Pricing\n\n```bash\n\u003e mocean account:pricing\n```\n\nAlias : `mocean ap`\n\n### Sms\n\nTo use [Mocean's SMS API][doc_sms] to send an SMS message, use `mocean sms \u003cto\u003e \u003ctext\u003e`.\n\n```bash\n\u003e mocean sms \u003cto\u003e \u003ctext\u003e\n```\n\nDefault from will be `Mocean CLI`, you can override it by providing `--from` option\n\n```bash\n\u003e mocean sms \u003cto\u003e \u003ctext\u003e --from \"Mocean\"\n```\n\nUse `--confirm` to skip confirmation step\n\n#### Sms Message Status\n\n```bash\n\u003e mocean sms:status \u003cmsg_id\u003e\n```\n\nQlias : `mocean ss \u003cmsg_id\u003e`\n\n### Number Lookup\n\n```bash\n\u003e mocean number:lookup \u003cnumber\u003e\n```\n\nQlias : `mocean nl \u003cnumber\u003e`\n\n### Options\n\n```bash\n\u003e mocean -h\n\nUsage: mocean [options] [command]\n\nOptions:\n  -V, --version                           output the version number\n  -h, --help                              output usage information\n\nCommands:\n  login [options] [api_key] [api_secret]  Login using your api key and api secret\n  logout [options]                        Logout\n  account|acc                             Show logged in account\n  account:balance|ab                      Check Account Balance\n  account:pricing|ap                      Get Account Pricing\n  sms [options] \u003cto\u003e \u003ctext...\u003e            Send a Sms\n  sms:status|ss \u003cmsg_id\u003e                  Check message status\n  number:lookup|nl [options] \u003cnumber\u003e     Perform Number Lookup\n```\n\nLicense\n-------\n\nThis library is released under the [MIT License][license]\n\n[signup]: https://dashboard.moceanapi.com/register?medium=github\u0026campaign=sdk-javascript\n[doc_sms]: https://moceanapi.com/docs/?shell#send-sms\n[license]: LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoceanapi%2Fmocean-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmoceanapi%2Fmocean-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoceanapi%2Fmocean-cli/lists"}