{"id":15160124,"url":"https://github.com/koki-develop/askai","last_synced_at":"2025-10-24T18:30:24.466Z","repository":{"id":195025990,"uuid":"692285881","full_name":"koki-develop/askai","owner":"koki-develop","description":"🤖 AI is with you.","archived":false,"fork":false,"pushed_at":"2024-09-23T22:27:11.000Z","size":2754,"stargazers_count":12,"open_issues_count":14,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-09-28T13:44:46.031Z","etag":null,"topics":["chatgpt","cli","openai"],"latest_commit_sha":null,"homepage":"","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/koki-develop.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-09-16T02:46:38.000Z","updated_at":"2024-09-21T07:06:37.000Z","dependencies_parsed_at":"2023-09-16T07:53:17.575Z","dependency_job_id":"5db8b1ae-1e40-4f08-abc0-ee317e03ec3d","html_url":"https://github.com/koki-develop/askai","commit_stats":{"total_commits":78,"total_committers":2,"mean_commits":39.0,"dds":"0.038461538461538436","last_synced_commit":"6298574ee109daf658e608b92471bf04ca45e857"},"previous_names":["koki-develop/askai"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koki-develop%2Faskai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koki-develop%2Faskai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koki-develop%2Faskai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/koki-develop%2Faskai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/koki-develop","download_url":"https://codeload.github.com/koki-develop/askai/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219868210,"owners_count":16555876,"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":["chatgpt","cli","openai"],"created_at":"2024-09-26T22:21:54.957Z","updated_at":"2025-10-24T18:30:23.987Z","avatar_url":"https://github.com/koki-develop.png","language":"Go","readme":"\u003ch1 align=\"center\"\u003easkai\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\nAI is with you.\u003cbr\u003e\n\u003csmall\u003ePowered by \u003ca href=\"https://openai.com/blog/openai-api\"\u003eOpenAI API\u003c/a\u003e\u003c/small\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://github.com/koki-develop/askai/releases/latest\"\u003e\u003cimg src=\"https://img.shields.io/github/v/release/koki-develop/askai\" alt=\"GitHub release (latest by date)\"\u003e\u003c/a\u003e\n\u003ca href=\"https://github.com/koki-develop/askai/actions/workflows/ci.yml\"\u003e\u003cimg src=\"https://img.shields.io/github/actions/workflow/status/koki-develop/askai/ci.yml?logo=github\" alt=\"GitHub Workflow Status\"\u003e\u003c/a\u003e\n\u003ca href=\"https://codeclimate.com/github/koki-develop/askai/maintainability\"\u003e\u003cimg src=\"https://img.shields.io/codeclimate/maintainability/koki-develop/askai?style=flat\u0026amp;logo=codeclimate\" alt=\"Maintainability\"\u003e\u003c/a\u003e\n\u003ca href=\"https://goreportcard.com/report/github.com/koki-develop/askai\"\u003e\u003cimg src=\"https://goreportcard.com/badge/github.com/koki-develop/askai\" alt=\"Go Report Card\"\u003e\u003c/a\u003e\n\u003ca href=\"./LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/github/license/koki-develop/askai\" alt=\"LICENSE\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"./assets/demo.gif\" \u003e\n\u003c/p\u003e\n\n## Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Getting Started](#getting-started)\n- [LICENSE](#license)\n\n## Installation\n\n### Homebrew Tap\n\n```console\n$ brew install koki-develop/tap/askai\n```\n\n### `go install`\n\n```console\n$ go install github.com/koki-develop/askai@latest\n```\n\n### Releases\n\nDownload the binary from the [releases page](https://github.com/koki-develop/askai/releases/latest).\n\n## Usage\n\n```console\n$ askai --help\nAI is with you.\n\nUsage:\n  askai [flags] [question]\n\nFlags:\n  -k, --api-key string   the OpenAI API key\n      --configure        configure askai\n  -g, --global           configure askai globally (only for --configure)\n  -h, --help             help for askai\n  -i, --interactive      interactive mode\n  -m, --model string     the chat completion model to use (default \"gpt-3.5-turbo\")\n  -v, --version          version for askai\n```\n\n## Getting Started\n\n### Setup\n\nFirst, run `askai` with the `--configure` flag set.\n\n```console\n$ askai --configure\n```\n\nUpon doing this, an interactive setup session will be initiated.  \nInput the following items:\n\n- OpenAI API Key: API key created on [the OpenAI platform](https://platform.openai.com).\n- Model: The chat completion model to use. (Available: `gpt-4`, `gpt-4-0613`, `gpt-4-32k`, `gpt-4-32k-0613`, `gpt-3.5-turbo`, `gpt-3.5-turbo-0613`, `gpt-3.5-turbo-16k`, `gpt-3.5-turbo-16k-0613`)\n\nOnce the setup is completed, a configuration file named `.askai` will be created.  \nNow, you are all set.\n\n\u003e [!NOTE]\n\u003e If you run `askai --configure` with the `--global` flag set, the configuration file will be created as `$HOME/.askai`.  \n\u003e This file is referred to when executing `askai`, if there is no `.askai` in the current directory.\n\n### Ask a question to AI\n\nBy passing a question as an argument to `askai`, you can obtain an answer from AI.\n\n```console\n$ askai 'Please write a program in Go that outputs \"Hello world”.'\n```\n\n![](./assets/oneshot.gif)\n\n### Ask a question to AI interactively\n\nBy running `askai` with the `-i` or `--interactive` flag set, you can ask questions to AI in an interactive manner.\n\n```console\n$ askai -i\n```\n\n![](./assets/demo.gif)\n\n### Pass a question from stdin\n\nYou can also pass questions from stdin.\n\n```sh\n# pipe\n$ echo 'QUESTION' | askai\n\n# file\n$ askai \u003c question.txt\n```\n\nYou can pass both input from stdin and arguments at the same time.  \nBy utilizing this, for example, you can also summarize the contents of a specific file.\n\n```console\n$ cat README.md | askai 'Please summarize this content'\n```\n\n![](./assets/summarize.gif)\n\n## LICENSE\n\n[MIT](./LICENSE)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoki-develop%2Faskai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkoki-develop%2Faskai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkoki-develop%2Faskai/lists"}