{"id":26359146,"url":"https://github.com/assemblyai/assemblyai-cli","last_synced_at":"2025-04-06T18:13:40.322Z","repository":{"id":60993034,"uuid":"328751722","full_name":"AssemblyAI/assemblyai-cli","owner":"AssemblyAI","description":"CLI for the AssemblyAI API","archived":false,"fork":false,"pushed_at":"2024-05-06T11:57:05.000Z","size":325619,"stargazers_count":181,"open_issues_count":13,"forks_count":28,"subscribers_count":14,"default_branch":"main","last_synced_at":"2024-05-06T13:03:49.288Z","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":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AssemblyAI.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2021-01-11T18:10:46.000Z","updated_at":"2024-06-19T02:48:48.871Z","dependencies_parsed_at":"2023-12-28T13:53:16.114Z","dependency_job_id":"d573eeeb-584a-4630-97c6-5b10dd00023e","html_url":"https://github.com/AssemblyAI/assemblyai-cli","commit_stats":{"total_commits":324,"total_committers":8,"mean_commits":40.5,"dds":0.3364197530864198,"last_synced_commit":"c8eb9bf38ca71554fead620313764e90f39ff0d5"},"previous_names":[],"tags_count":69,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AssemblyAI%2Fassemblyai-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AssemblyAI%2Fassemblyai-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AssemblyAI%2Fassemblyai-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AssemblyAI%2Fassemblyai-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AssemblyAI","download_url":"https://codeload.github.com/AssemblyAI/assemblyai-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247526753,"owners_count":20953143,"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":"2025-03-16T15:58:51.362Z","updated_at":"2025-04-06T18:13:40.265Z","avatar_url":"https://github.com/AssemblyAI.png","language":"Go","readme":"# AssemblyAI CLI\n\n![Release](https://img.shields.io/github/v/release/assemblyai/assemblyai-cli)\n![Build](https://img.shields.io/github/actions/workflow/status/assemblyai/assemblyai-cli/release.yml)\n![License](https://img.shields.io/github/license/assemblyai/assemblyai-cli)\n\nThe AssemblyAI CLI helps you quickly test our latest AI models right from your terminal, with minimal installation required.\n\n![Thumbnail](./assets/thumbnail.png)\n\n## Installation\n\nThe CLI is simple to install, supports a wide range of operating systems like macOS, Windows, and Linux, and makes it more seamless to build with AssemblyAI.\n\n### Homebrew\n\nIf you're on macOS, you can install it using Homebrew:\n\n```bash\nbrew tap assemblyai/assemblyai\nbrew install assemblyai\n```\n\n### macOS or Linux\n\nIf you don't have Homebrew installed, or are running Linux:\n\n```bash\n/bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/AssemblyAI/assemblyai-cli/main/install.sh)\"\n```\n\n### Windows\n\nThe CLI is available on Windows either via Scoop or by script.\n\nVia Scoop:\n\n```powershell\nscoop bucket add assemblyai https://github.com/assemblyai/scoop-assemblyai.git\nscoop install assemblyai\n```\n\nOr via PowerShell as an administrator:\n\n```powershell\nSet-ExecutionPolicy RemoteSigned -Scope CurrentUser\nirm https://raw.githubusercontent.com/AssemblyAI/assemblyai-cli/main/install.ps1 | iex\nNew-Alias -Name assemblyai -Value $Env:Programfiles/AssemblyAI/assemblyai.exe\n```\n\n## Getting started\n\nGet started by configuring the CLI with your AssemblyAI token. If you don't yet have an account, create one [here](https://www.assemblyai.com/app).\n\n```bash\nassemblyai config [token]\n```\n\nThis command will validate your account, and store your token safely in `~/.config/assemblyai/config.toml` later to be used when transcribing files.\n\nYou can now transcribe local files and remote URLs.\n\n```bash\nassemblyai transcribe ./file.mp3 --auto_highlights --entity_detection\n```\n\n## Usage\n\nInstalling the CLI provides access to the `assemblyai` command:\n\n```bash\nassemblyai [command] [--flags]\n```\n\n## Commands\n\n### Transcribe\n\nWith the CLI, you can transcribe local files and remote URLs.\n\n```bash\nassemblyai transcribe [local file | remote url] [--flags]\n```\n\n\u003cdetails\u003e\n  \u003csummary\u003eFlags\u003c/summary\u003e\n  \n  \u003e **-j, --json**  \n  \u003e default: false  \n  \u003e example: `-j` or `--json`  \n  \u003e If true, the CLI will output the JSON.\n\n\u003e **-p, --poll**  \n\u003e default: true  \n\u003e example: `-p` or `--poll`  \n\u003e The CLI will poll the transcription every 3 seconds until it's complete.\n\n\u003e **-s, --auto_chapters**  \n\u003e default: false  \n\u003e example: `-s` or `--auto_chapters`  \n\u003e A \"summary over time\" for the audio file transcribed.\n\n\u003e **-a, --auto_highlights**  \n\u003e default: false  \n\u003e example: `-a` or `--auto_highlights`  \n\u003e Automatically detect important phrases and words in the text.\n\n\u003e **-c, --content_moderation**  \n\u003e default: false  \n\u003e example: `-c` or `--content_moderation`  \n\u003e Detect if sensitive content is spoken in the file.\n\n\u003e **-d, --dual_channel**  \n\u003e default: false  \n\u003e example: `-d` or `--dual_channel`  \n\u003e Enable dual channel\n\n\u003e **-D, --disfluencies**  \n\u003e default: false  \n\u003e example: `-D` or `--disfluencies`  \n\u003e Include Filler Words in your transcript\n\n\u003e **-e, --entity_detection**  \n\u003e default: false  \n\u003e example: `-e` or `--entity_detection`  \n\u003e Identify a wide range of entities that are spoken in the audio file.\n\n\u003e **-f, --format_text**  \n\u003e default: true  \n\u003e example: `-f=false` or `--format_text=false`  \n\u003e Enable text formatting\n\n\u003e **-u, --punctuate**  \n\u003e default: true  \n\u003e example: `-u=false` or `--punctuate=false`  \n\u003e Enable automatic punctuation\n\n\u003e **-r, --redact_pii**  \n\u003e default: false  \n\u003e example: `-r` or `--redact_pii`  \n\u003e Remove personally identifiable information from the transcription.\n\n\u003e **-i, --redact_pii_policies**  \n\u003e default: drug,number_sequence,person_name  \n\u003e example: `-i medical_process,nationality` or `--redact_pii_policies medical_process,nationality`  \n\u003e The list of PII policies to redact ([source](https://www.assemblyai.com/docs/Models/pii_redaction)), comma-separated. Required if the redact_pii flag is true.\n\n\u003e **-x, --sentiment_analysis**  \n\u003e default: false  \n\u003e example: `-x` or `--sentiment_analysis`  \n\u003e Detect the sentiment of each sentence of speech spoken in the file.\n\n\u003e **-l, --speaker_labels**  \n\u003e default: true  \n\u003e example: `-l=false` or `--speaker_labels=false`  \n\u003e Automatically detect the number of speakers in the file.\n\n\u003e **-t, --topic_detection**  \n\u003e default: false  \n\u003e example: `-t` or `--topic_detection`  \n\u003e Label the topics that are spoken in the file.\n\n\u003e **-w, --webhook_url**  \n\u003e example: `--webhook_url \"https://example.com/\"`  \n\u003e Receive a webhook once your transcript is complete.\n\n\u003e **-b, --webhook_auth_header_name**  \n\u003e example: `--webhook_auth_header_name \"Authorization\"`  \n\u003e Containing the header's name which will be inserted into the webhook request.\n\n\u003e **-o, --webhook_auth_header_value**  \n\u003e example: `--webhook_auth_header_value \"foo:bar\"`  \n\u003e Receive a webhook once your transcript is complete.\n\n\u003e **-n, --language_detection**  \n\u003e default: false  \n\u003e example: `-n` or `--language_detection`  \n\u003e Automatic identify the dominant language that’s spoken in an audio file.\n\u003e [Here](https://www.assemblyai.com/docs/Models/speech_recognition#automatic-language-detection) you can view the ALD list for supported languages\n\n\u003e **-g, --language_code**  \n\u003e example: `-g es` or `--language_code es`  \n\u003e Manually specify the language of the speech in your audio file.\n\u003e Click [here](https://www.assemblyai.com/docs/Concepts/faq#supported-languages) to view all the supported languages\n\n\u003e **-m, --summarization**  \n\u003e default: false  \n\u003e example: `-m` or `--summarization`  \n\u003e Generate a single abstractive summary of the entire audio.\n\n\u003e **-q, --summary_model**\n\u003e default: bullets  \n\u003e example: `-q conversational` or `--summary_model conversational`  \n\u003e Type of summary generated.\n\u003e Click [here](https://www.assemblyai.com/docs/Models/summarization) to view all the supported types\n\n\u003e **-y, --summary_type**\n\u003e default: bullets  \n\u003e example: `-y paragraph` or `--summary_type paragraph`  \n\u003e Model of summary generated.\n\u003e Click [here](https://www.assemblyai.com/docs/Models/summarization) to view all the supported types\n\n\u003e **-k, --word_boost**\n\u003e example: `-k \"sally mcmanus,the IQEZ iPhone app\"` or `--word_boost \"sally mcmanus,the IQEZ iPhone app\"`  \n\u003e Any term included will have its likelihood of being transcribed boosted.\n\n\u003e **-z, --boost_param**\n\u003e example: `-z high` or `--word_boost high`  \n\u003e Control how much weight should be applied to your boosted keywords/phrases. This value can be either low, default, or high.\n\u003e **--custom_spelling**\n\u003e example: `--custom_spelling \"[{\\\"from\\\": [\\\"ariana\\\"], \\\"to\\\": \\\"Arianna\\\"}]\"` or `--custom_spelling ./custom_spelling.json`\n\u003e Specify how words are spelled or formatted in the transcript text.\n\n\u003e **--srt**  \n\u003e default: false  \n\u003e example: `--srt`  \n\u003e Create an SRT file named `[id].srt` in the current directory.\n\n\u003c/details\u003e\n\n### Get\n\nIf you're not polling the transcription, you can fetch it later:\n\n```bash\nassemblyai get [id]\n```\n\n\u003cdetails\u003e\n  \u003csummary\u003eFlags\u003c/summary\u003e\n  \n  \u003e **-j, --json**  \n  \u003e default: false  \n  \u003e example: `--json` or `--json=true`  \n  \u003e If true, the CLI will output the JSON.\n\n\u003e **-p, --poll**  \n\u003e default: true  \n\u003e example: `--poll=false`  \n\u003e The CLI will poll the transcription every 3 seconds until it's complete.\n\n\u003e **--srt**  \n\u003e default: false  \n\u003e example: `--srt`  \n\u003e Create an SRT file named `[id].srt` in the current directory.\n\n\u003c/details\u003e\n\n### Exporting Output to a File\n\nYou can export the output of AssemblyAI CLI commands to a file by using [shell redirection](https://www.gnu.org/software/bash/manual/html_node/Redirections.html). To export the output to a text file, use the `\u003e` operator followed by the name of the file you want to create.\n\n```bash\nassemblyai get [id] \u003e transcript.txt\n```\n\nTo save the raw JSON response from the API, you can do this instead:\n\n```bash\nassemblyai get [id] -j \u003e transcript.json\n```\n\nNote that if the file you are exporting to already exists, its contents will be overwritten. If you want to append the output to an existing file, use the `\u003e\u003e` operator instead of `\u003e`.\n\n## Contributing\n\nWe're more than happy to welcome new contributors. If there's something you'd like to fix or improve, start by [creating an issue](https://github.com/AssemblyAI/assemblyai-cli/issues). Please make sure to follow our [code of conduct](https://github.com/AssemblyAI/assemblyai-cli/blob/main/CODE_OF_CONDUCT.md).\n\n## Telemetry\n\nThe AssemblyAI CLI includes a telemetry feature that collects usage data and is enabled by default.\n\nTo opt out of telemetry, set the telemetry variable in the `config.toml` file to false.\n\n## Upgrade\n\nOur team regularly releases updates to ensure world-class service, so make sure to update your CLI when a new release is available. You can do so by running the same commands as shown on the [Installation](#installation) section, or, if you've installed using brew, run:\n\n```bash\nbrew upgrade assemblyai\n```\n\n## Feedback\n\nPlease don't hesitate to [let us know what you think](https://forms.gle/oQgktMWyL7xStH2J8)!\n\n## Uninstall\n\n```bash\n/bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/AssemblyAI/assemblyai-cli/main/uninstall.sh)\"\n```\n\nWe'd love to understand why you're uninstalling the CLI, and what we can do to improve it. Feel free to [reach out](https://forms.gle/oQgktMWyL7xStH2J8).\n\n## License\n\nCopyright (c) AssemblyAI. All rights reserved.\n\nLicensed under the [Apache License 2.0 license](https://github.com/AssemblyAI/assemblyai-cli/blob/main/LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fassemblyai%2Fassemblyai-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fassemblyai%2Fassemblyai-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fassemblyai%2Fassemblyai-cli/lists"}