{"id":21762090,"url":"https://github.com/segment-integrations/segmentcli","last_synced_at":"2025-03-21T04:41:36.752Z","repository":{"id":184549261,"uuid":"277614224","full_name":"segment-integrations/segmentcli","owner":"segment-integrations","description":null,"archived":false,"fork":false,"pushed_at":"2024-07-25T17:54:50.000Z","size":112,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-01-26T01:20:04.704Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Swift","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/segment-integrations.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-06T18:05:33.000Z","updated_at":"2024-07-25T17:54:54.000Z","dependencies_parsed_at":"2024-01-23T00:24:12.564Z","dependency_job_id":"280cb242-dcd4-4984-95bb-63d03b7e47ff","html_url":"https://github.com/segment-integrations/segmentcli","commit_stats":null,"previous_names":["segment-integrations/segmentcli"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/segment-integrations%2Fsegmentcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/segment-integrations%2Fsegmentcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/segment-integrations%2Fsegmentcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/segment-integrations%2Fsegmentcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/segment-integrations","download_url":"https://codeload.github.com/segment-integrations/segmentcli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244739944,"owners_count":20501990,"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-26T12:10:53.729Z","updated_at":"2025-03-21T04:41:36.728Z","avatar_url":"https://github.com/segment-integrations.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Segment CLI\n\nThe Segment CLI (segmentcli) is a command line utility used to work with Analytics\nLive Plugins in your Segment work space.\n\n```bash\nUsage: segmentcli \u003ccommand\u003e [options]\n\nA command line utility to interact with and drive Segment\n\nGroups:\n  profile         Work with stored profiles on this device\n  analytics       Send custom crafted events to Segment\n  liveplugins     Work with and develop analytics live plugins\n  sources         View and edit workspace sources\n\nCommands:\n  auth            Authenticate with Segment.com and assign a profile name\n  import          Import CSV data into Segment from\n  scaffold        Create baseline implementation of a given code artifact\n  repl            Segment virtual development environment\n  help            Prints help information\n  version         Prints the current version of this app\n```\n\n## Getting Started\n\nIn order to use the segmentcli to work with your workspace you must have the \nAnalytics Live Plugins featured enabled in your workspace and you must \nauthenticate with that workspace.\n\n### Installation\n\nRun this command to install segmentcli locally from the repo:\n```bash\n$ sudo make install\n```\n\nor, using brew:\n```bash\n$ brew install segment-integrations/formulae/segmentcli\n```\n\n### Enabling the Analytics Live Plugins feature\n\nReach out to your Customer Support Engineer (CSE) or Customer Success Manager (CSM) \nto have them add this feature to your account.\n\nThe command to authenticate is as follows:\n\n```bash\n$ segmentcli auth \u003cProfileName\u003e \u003cAuthToken\u003e\n```\n\n`ProfileName` - is the name you give to this workspace so you can distinguish\nbetween various local profiles.\n\n`AuthToken` - is the AuthToken associated with your workspace. You must create\nan Auth token in your Segment workspace.\n\n### Creating an Auth Token\n\n1. Log into https://app.segment.com\n1. Navigate to Settings \u003e Workspace Settings \u003e Access Management \u003e Tokens\n1. Generate a new token using the \"Create token\" button with the Workspace Owner role.\n\n## Uploading Your Analytics Live Plugins to Your Workspace\n\nIn order to upload your Analytics Live Plugins you'll need the following command:\n\n```bash\n$ segmentcli liveplugins upload \u003cSourceId\u003e \u003cFileName\u003e\n```\n\n`SourceId` - This is listed next your Write Key in the Segment app.\n`FileName` - The name of the JavaScript file containing your code.\n\nNote: It will take a few minutes for your Source's setting payload to be update\nwith the Analytics Live Plugin file URL.\n\n### Finding Your SourceID\n\n1. Log into https://app.segment.com\n1. Navigate to Connections \u003e Sources\n1. Choose the source for which we're adding Analytics Live Plugins\n1. Navigate to Settings \u003e API Keys\n1. You'll find the \"Source ID\" at the top of the page.\n\n\n## References\n\nLearn more about Analytics Live Plugins for [Swift](https://github.com/segment-integrations/analytics-swift-live) and [Kotlin](https://github.com/segment-integrations/analytics-swift-live).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsegment-integrations%2Fsegmentcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsegment-integrations%2Fsegmentcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsegment-integrations%2Fsegmentcli/lists"}