{"id":13525922,"url":"https://github.com/ozh/yourls-bash","last_synced_at":"2025-04-11T18:07:49.693Z","repository":{"id":49971643,"uuid":"374395742","full_name":"ozh/yourls-bash","owner":"ozh","description":"Simple bash script to shorten URLs with YOURLS","archived":false,"fork":false,"pushed_at":"2021-12-16T11:29:03.000Z","size":4,"stargazers_count":13,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-11T18:05:59.598Z","etag":null,"topics":["bash","command-line-tool","yourls","yourls-api","yourls-extension"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/ozh.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":"2021-06-06T15:28:34.000Z","updated_at":"2024-11-06T10:10:46.000Z","dependencies_parsed_at":"2022-09-16T13:11:02.673Z","dependency_job_id":null,"html_url":"https://github.com/ozh/yourls-bash","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ozh%2Fyourls-bash","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ozh%2Fyourls-bash/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ozh%2Fyourls-bash/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ozh%2Fyourls-bash/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ozh","download_url":"https://codeload.github.com/ozh/yourls-bash/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248456369,"owners_count":21106603,"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":["bash","command-line-tool","yourls","yourls-api","yourls-extension"],"created_at":"2024-08-01T06:01:23.538Z","updated_at":"2025-04-11T18:07:49.666Z","avatar_url":"https://github.com/ozh.png","language":"Shell","funding_links":[],"categories":["Integrations"],"sub_categories":["3rd party Integrations and Frameworks"],"readme":"# YOURLS BASH [![Listed in Awesome YOURLS!](https://img.shields.io/badge/Awesome-YOURLS-C5A3BE)](https://github.com/YOURLS/awesome-yourls/)\nA simple bash script to shorten URLs with [YOURLS](https://yourls.org) \n\n![image](https://user-images.githubusercontent.com/223647/120930653-8a50cf80-c6ee-11eb-8972-22197382bfa4.png)\n\n## Installation\n\n```shell\n# using wget\n$\u003e wget -q https://raw.githubusercontent.com/ozh/yourls-bash/master/yourls\n# using curl\n$\u003e curl -s -o yourls https://raw.githubusercontent.com/ozh/yourls-bash/master/yourls\n```\n\nThen, edit the two parameters at the beginning of the script (`YOURLS_HOST` and `YOURLS_KEY`) to match your setup.\n\nDepending on your setup, you may want to make this file executable (`chmod +x yourls`) and in your $PATH (eg `~/bin` maybe)\n\n## Usage\n\nShorten a long URL :\n\n```bash\n$\u003e yourls https://someverylongdomain.com\nhttps://sho.rt/ef\n```\n\nShorten a long URL and provide a custom keyword and a custom title :\n\n```bash\n$\u003e yourls https://someverylongurl.com -k test12 --title \"Some title\"\nhttps://sho.rt/test12\n```\n\nShorten a URL and receive JSON output, for instance to display with `jq` :\n```bash\n$\u003e yourls https://example.com -f json | jq\n{\n  \"url\": {\n    \"keyword\": \"Nzs\",\n    \"url\": \"https://example.com\",\n    \"title\": \"Example Domain\",\n    \"date\": \"2021-06-06 16:03:44\",\n    \"ip\": \"127.0.0.1\"\n  },\n  \"status\": \"success\",\n  \"message\": \"http://example.com added to database\",\n  \"title\": \"Example Domain\",\n  \"shorturl\": \"http://sho.rt/Nzs\",\n  \"statusCode\": 200\n}\n```\n\nDisplay help message :\n```bash\n$\u003e yourls --help\n```\n\n## License\n\nDo whatever the hell you want with it\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fozh%2Fyourls-bash","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fozh%2Fyourls-bash","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fozh%2Fyourls-bash/lists"}