{"id":20643872,"url":"https://github.com/adjust/adjust-cli","last_synced_at":"2025-05-10T08:31:09.522Z","repository":{"id":57498241,"uuid":"56188242","full_name":"adjust/adjust-cli","owner":"adjust","description":"Command line interface for adjust APIs","archived":true,"fork":false,"pushed_at":"2016-05-09T16:50:12.000Z","size":7316,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-03-09T14:39:51.074Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","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/adjust.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":"2016-04-13T21:44:59.000Z","updated_at":"2024-08-22T09:41:46.000Z","dependencies_parsed_at":"2022-08-28T17:12:34.128Z","dependency_job_id":null,"html_url":"https://github.com/adjust/adjust-cli","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adjust%2Fadjust-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adjust%2Fadjust-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adjust%2Fadjust-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/adjust%2Fadjust-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/adjust","download_url":"https://codeload.github.com/adjust/adjust-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253389737,"owners_count":21900805,"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":[],"created_at":"2024-11-16T16:14:10.341Z","updated_at":"2025-05-10T08:31:08.919Z","avatar_url":"https://github.com/adjust.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Adjust Command Line Utility\n\nThis is an UNIX command line utility that streamlines your access to the Adjust\nAPIs. Use this tool for a quick access to all Adjust apps and KPIs data you run.\n\n### Installation\n\n[DISCLAIMER] This software is still in pre-release mode, and complete\ninstallation guides are still being developed.\n\n#### Mac OS X\n\nInstall using homebrew by typing this line in your terminal:\n\n```\nbrew tap adjust/tap \u0026\u0026 brew install adjust\n```\n\n### Commands\n\nThe adjust tool has three commands: `adjust config`, `adjust deliverables` and `adjust cohorts`. You can see details for\neach of these by typing for example: `adjust deliverables --help`. There's also general help: `adjust --help`.\n\nLet's run through each of the commands with a few examples.\n\n#### Config\n\nTo access the adjust APIs you'll need to authorize with your user token. You can obtain it from the accounts settings on\nyour adjust dashboard.\n\n```\nadjust config --user-token P1jTcnGvDbs-Nvz6ypQ2\n```\n\nThis will create a file called `~/.adjustrc` containing all configuration settings for adjust. Further options to\n`adjust config` include:\n\n```\nadjust config --app-token my-app-token\n```\n\nSome commands support multiple app-tokens (e.g. `adjust deliverables`). For these, you can configure multiple app-tokens\ntoo like this:\n\n```\nadjust config --app-tokens my-app-token1,my-app-token2\n```\n\n#### Deliverables\n\nAccessing your tracking data is done via the KPI Service API. While the adjust tool provides extensive inline help on\nthe `deliverables` and `cohorts` commands, you're still encouraged to keep track of the [KPI Service\ndocs](https://docs.adjust.com/en/kpi-service/).\n\n```\nadjust deliverables -k installs\n```\n\nThis will print a nicely formatted table on your terminal with the installs for the configured app this month, by\ndefault grouped by `networks`. If you prefer not working with a configured app, but passing an app token instead, you can:\n\n```\nadjust deliverables -k installs -a my-app-token\n```\n\nPassing more than one app token as well as changing the grouping is also supported.\n\n```\nadjust deliverables -k installs -a my-app-token1,my-app-token2 -g apps,networks\n```\n\nYou can also specify start and end dates for your requests, apply filtering by country, OS name, etc.\n\n```\nadjust deliverables -a app-token-1,app-token-2 -k installs,sessions -s 2015-01-01 -e 2015-10-10 -c de,gb -g app,network\n```\n\nCheck out `adjust deliverables --help` for more examples and usage details.\n\n#### Cohorts\n\nFor cohort or event queries, run:\n\n```\nadjust cohorts -a ckrgvqfu1nx3 -k retained_users\n```\n\nAgain `adjust cohorts --help` will give you more details.\n\n### Output Format\n\nBy default the adjust tool prints results in a table-formatted output to the terminal. You can change that to printing\nCSV using the `--csv` flag on every `deliverables` or `cohorts` request. This might be useful if you wish, for example,\nto pipe the output for further processing.\n\nFurthermore, you can directly save the CSV output to a file on your computer by passing `--file path/to/file`.\n\nThere's also a `--verbose` flag, which prints more details along the execution and the `--url-only` which only prints\nthe API URL for the request, but doesn't execute it.\n\n### TODOs\n\n  - Add and distribute tab completion.\n  - Provide Windows support.\n  - Implement basic 'smart' default groupings - e.g. group by network for single app-token requests and by\n    `apps,networks` for multiple apps.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadjust%2Fadjust-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fadjust%2Fadjust-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fadjust%2Fadjust-cli/lists"}