Skip to main content

AI-powered terminal command assistant

Project description

aisk 🚀

aisk 是一个基于 AI 的终端命令助手。只需用自然语言描述你的需求,它就能为你生成相应的 Shell 命令,并支持一键执行。

✨ 特性

  • 自然语言转命令:不再需要苦记复杂的 tarfindffmpeg 参数。
  • 交互式执行:生成命令后,你可以选择立即执行、复制或取消。
  • 高度可配置:支持自定义 API Key、Base URL 以及模型(默认支持通义千问)。
  • 轻量快捷:基于 Python 开发,极速响应。

📦 安装

方式 1:直接通过 PyPI 安装 (推荐)

这是最简单的安装方式,适用于大多数用户:

pip install aisk

方式 2:从源码安装

如果你想参与开发或尝试最新版本:

git clone https://github.com/it-zhouyu/aisk.git
cd aisk
pip install .

⚙️ 配置

在使用之前,请确保你已配置环境变量。建议将以下内容添加到你的 .zshrc.bash_profile 中:

# 必填:你的 API Key
export ASK_API_KEY="your_api_key_here"

# 选填:自定义 Base URL (默认为通义千问)
export ASK_BASE_URL="https://dashscope.aliyuncs.com/compatible-mode/v1"

# 选填:自定义模型 (默认为 qwen-max)
export ASK_MODEL_NAME="qwen-max"

💡 使用方法

直接在终端输入 aisk 加上你的需求:

1. 查找文件

aisk 帮我找到当前目录下所有大于 100MB  mp4 文件

2. 压缩/解压

aisk 把当前文件夹打包成 tar.gz 格式,排除 node_modules

3. 系统操作

aisk 查看并杀死占用 8080 端口的进程

🛠 交互逻辑

生成命令后,aisk 会提示:

  • EnterY: 确认并立即执行命令。
  • N: 取消执行。
  • Esc/其他: 退出程序。

📄 开源协议

本项目采用 MIT 协议。


🤝 贡献

如果你有任何改进建议,欢迎提交 Issue 或 Pull Request!

**Made with ❤️ by it_zhouyu**

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aisk-0.1.1.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aisk-0.1.1-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file aisk-0.1.1.tar.gz.

File metadata

  • Download URL: aisk-0.1.1.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.3

File hashes

Hashes for aisk-0.1.1.tar.gz
Algorithm Hash digest
SHA256 49858927395ee1aeeaaedb61b1a41eec9baa423d0ebaaab8c866fc5edf397829
MD5 72015d1ed5f2f7cc7bf758c765afb548
BLAKE2b-256 5d4e836b709da9b0f74b0cde268d76e51fc630497820fc2641b61685897696ff

See more details on using hashes here.

File details

Details for the file aisk-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: aisk-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 4.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.3

File hashes

Hashes for aisk-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9e5d64e5e152b09a5e5830cdad3661d5815a488bf181ede507c64c2ad60ababe
MD5 06196137401b9955b9694d57563df812
BLAKE2b-256 88445192ceb9372b9ec5817cf7b60100691cbc741b4771ac86db38aa150fa77d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page