├── CNAME ├── docs ├── tags.md ├── overrides │ └── partials │ │ └── footer.html ├── stylesheets │ └── extra.css ├── index.md ├── trae.md ├── vibe-kanban.md ├── zed.md ├── amazon-q-cli.md ├── ruler.md ├── llm.md ├── cline.md ├── open-code.md ├── open-hands.md ├── roocode.md ├── gemini-cli.md ├── goose.md ├── refact.md ├── aider.md ├── continue.md ├── codex-cli.md └── github-copilot-chat.md ├── Makefile ├── .github └── workflows │ └── deploy.yml ├── .gitignore ├── mkdocs.yml ├── README.md └── LICENSE /CNAME: -------------------------------------------------------------------------------- 1 | oss-ai-swe.org -------------------------------------------------------------------------------- /docs/tags.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Tags 3 | --- 4 | 5 | # Tags 6 | 7 | Click on a tag to see all pages associated with it. 8 | 9 | [TAGS] -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: install serve 2 | 3 | install: 4 | uv pip install mkdocs mkdocs-material 5 | 6 | serve: 7 | uv run mkdocs serve 8 | -------------------------------------------------------------------------------- /docs/overrides/partials/footer.html: -------------------------------------------------------------------------------- 1 |
2 |
3 | 4 | CC0 1.0 Universal 5 | 6 |  ・  7 | Eleanor Berger (AI Expertise) 8 | and the OSS AI SWE Community 9 |
10 | 11 | -------------------------------------------------------------------------------- /docs/stylesheets/extra.css: -------------------------------------------------------------------------------- 1 | :root { 2 | --md-primary-fg-color: #DC143C; 3 | } 4 | 5 | /* Custom footer styles */ 6 | .custom-footer { 7 | padding: 1.5em 0; 8 | font-size: 1.1em; 9 | text-align: center; 10 | } 11 | .custom-footer a { 12 | color: var(--md-primary-fg-color, #DC143C); 13 | text-decoration: none; 14 | font-weight: 500; 15 | transition: color 0.2s, text-decoration 0.2s; 16 | } 17 | .custom-footer a:hover, .custom-footer a:focus { 18 | color: #a0102a; 19 | text-decoration: underline; 20 | } 21 | -------------------------------------------------------------------------------- /docs/index.md: -------------------------------------------------------------------------------- 1 | # Welcome to the Community Guide to Open-Source AI Software Craft 2 | 3 | This is a community-managed informational website with a comprehensive guide to open-source tools available in the AI-assisted software development / software engineering space. 4 | 5 | --- 6 | 7 | - [Aider](./aider.md) 8 | - [Amazon Q CLI](./amazon-q-cli.md) 9 | - [Cline](./cline.md) 10 | - [Codex CLI](./codex-cli.md) 11 | - [Continue](./continue.md) 12 | - [Gemini CLI](./gemini-cli.md) 13 | - [GitHub Copilot Chat](./github-copilot-chat.md) 14 | - [Goose](./goose.md) 15 | - [LLM](./llm.md) 16 | - [OpenCode](./open-code.md) 17 | - [OpenHands](./open-hands.md) 18 | - [Refact](./refact.md) 19 | - [RooCode](./roocode.md) 20 | - [Ruler](./ruler.md) 21 | - [Trae](./trae.md) 22 | - [Vibe Kanban](./vibe-kanban.md) 23 | - [Zed](./zed.md) 24 | -------------------------------------------------------------------------------- /.github/workflows/deploy.yml: -------------------------------------------------------------------------------- 1 | name: docs 2 | on: 3 | push: 4 | branches: 5 | - main 6 | 7 | permissions: 8 | contents: read 9 | pages: write 10 | id-token: write 11 | 12 | jobs: 13 | build: 14 | runs-on: ubuntu-latest 15 | steps: 16 | - uses: actions/configure-pages@v5 17 | - uses: actions/checkout@v4 18 | - uses: actions/setup-python@v5 19 | with: { python-version: '3.x' } 20 | 21 | - run: pip install mkdocs mkdocs-material 22 | - run: mkdocs build --site-dir site 23 | 24 | - run: echo oss-ai-swe.org > site/CNAME 25 | 26 | - uses: actions/upload-pages-artifact@v3 27 | with: { path: ./site } 28 | 29 | deploy: 30 | needs: build 31 | runs-on: ubuntu-latest 32 | environment: github-pages 33 | steps: 34 | - uses: actions/deploy-pages@v4 35 | -------------------------------------------------------------------------------- /docs/trae.md: -------------------------------------------------------------------------------- 1 | --- 2 | tags: 3 | - cli 4 | - agent 5 | --- 6 | 7 | # Trae 8 | 9 | | Website | GitHub | License | 10 | | --- | --- | --- | 11 | | [bytedance/trae-agent](https://github.com/bytedance/trae-agent) | [bytedance/trae-agent](https://github.com/bytedance/trae-agent) | Apache 2.0 | 12 | 13 | **Trae Agent is an LLM-based agent for general-purpose software engineering tasks.** 14 | 15 | Trae Agent is a command-line tool that uses large language models to understand natural language instructions and perform complex software engineering tasks. It supports multiple LLM providers and has a rich ecosystem of tools. 16 | 17 | ### Key Features 18 | 19 | * **Multi-LLM Support:** Works with OpenAI, Anthropic, Google Gemini, and other LLM providers. 20 | * **Rich Tool Ecosystem:** Includes tools for file editing, shell execution, and more. 21 | * **Interactive Mode:** Offers a conversational interface for iterative development. 22 | * **Trajectory Recording:** Logs all agent actions for debugging and analysis. 23 | 24 | ## Links 25 | 26 | * **GitHub:** https://github.com/bytedance/trae-agent 27 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # MkDocs documentation 2 | site/ 3 | 4 | # Python environments 5 | .venv/ 6 | venv/ 7 | env/ 8 | ENV/ 9 | .env 10 | 11 | # Python bytecode 12 | __pycache__/ 13 | *.py[cod] 14 | *$py.class 15 | 16 | # Distribution / packaging 17 | .Python 18 | build/ 19 | develop-eggs/ 20 | dist/ 21 | downloads/ 22 | eggs/ 23 | .eggs/ 24 | lib/ 25 | lib64/ 26 | parts/ 27 | sdist/ 28 | var/ 29 | wheels/ 30 | *.egg-info/ 31 | .installed.cfg 32 | *.egg 33 | MANIFEST 34 | 35 | # PyInstaller 36 | *.manifest 37 | *.spec 38 | 39 | # Installer logs 40 | pip-log.txt 41 | pip-delete-this-directory.txt 42 | 43 | # Unit test / coverage reports 44 | htmlcov/ 45 | .tox/ 46 | .coverage 47 | .coverage.* 48 | .cache 49 | nosetests.xml 50 | coverage.xml 51 | *.cover 52 | .hypothesis/ 53 | .pytest_cache/ 54 | 55 | # Jupyter Notebook 56 | .ipynb_checkpoints 57 | 58 | # pyenv 59 | .python-version 60 | 61 | # pipenv 62 | Pipfile.lock 63 | 64 | # PEP 582 65 | __pypackages__/ 66 | 67 | # Celery 68 | celerybeat-schedule 69 | celerybeat.pid 70 | 71 | # SageMath parsed files 72 | *.sage.py 73 | 74 | # Spyder project settings 75 | .spyderproject 76 | .spyproject 77 | 78 | # Rope project settings 79 | .ropeproject 80 | 81 | # mkdocs documentation 82 | /site 83 | 84 | # mypy 85 | .mypy_cache/ 86 | .dmypy.json 87 | dmypy.json -------------------------------------------------------------------------------- /mkdocs.yml: -------------------------------------------------------------------------------- 1 | site_name: Open-Source AI Software Craft 2 | site_url: https://oss-ai-swe.org/ 3 | repo_url: https://github.com/intellectronica/oss-ai-swe 4 | repo_name: intellectronica/oss-ai-swe 5 | theme: 6 | name: material 7 | features: 8 | - navigation.sections 9 | - toc.integrate 10 | - navigation.top 11 | - search.suggest 12 | - search.highlight 13 | - content.tabs.link 14 | - content.code.annotation 15 | - content.code.copy 16 | - navigation.expand 17 | language: en 18 | palette: 19 | - scheme: default 20 | primary: 'custom' 21 | toggle: 22 | icon: material/toggle-switch-off-outline 23 | name: Switch to dark mode 24 | - scheme: slate 25 | primary: 'custom' 26 | toggle: 27 | icon: material/toggle-switch 28 | name: Switch to light mode 29 | icon: 30 | repo: fontawesome/brands/github 31 | 32 | custom_dir: docs/overrides 33 | 34 | extra_css: 35 | - stylesheets/extra.css 36 | 37 | plugins: 38 | - search 39 | - tags: 40 | tags_file: tags.md 41 | 42 | nav: 43 | - Home: index.md 44 | - Tags: tags.md 45 | - Tools: 46 | - Aider: aider.md 47 | - Amazon Q CLI: amazon-q-cli.md 48 | - Cline: cline.md 49 | - Codex CLI: codex-cli.md 50 | - Continue: continue.md 51 | - Gemini CLI: gemini-cli.md 52 | - GitHub Copilot Chat: github-copilot-chat.md 53 | - Goose: goose.md 54 | - LLM: llm.md 55 | - OpenCode: open-code.md 56 | - OpenHands: open-hands.md 57 | - Refact: refact.md 58 | - RooCode: roocode.md 59 | - Ruler: ruler.md 60 | - Trae: trae.md 61 | - Vibe Kanban: vibe-kanban.md 62 | - Zed: zed.md 63 | -------------------------------------------------------------------------------- /docs/vibe-kanban.md: -------------------------------------------------------------------------------- 1 | --- 2 | tags: 3 | - gui 4 | - util 5 | --- 6 | 7 | # Vibe Kanban 8 | 9 | | Website | GitHub | License | 10 | | --- | --- | --- | 11 | | [vibekanban.com](https://vibekanban.com) | [BloopAI/vibe-kanban](https://github.com/BloopAI/vibe-kanban) | Apache 2.0 | 12 | 13 | **Vibe Kanban is a tool designed to streamline workflows involving AI coding agents like Claude Code and Gemini CLI. It allows human engineers to more effectively plan, review, and orchestrate the work of these agents.** 14 | 15 | Vibe Kanban is a powerful and flexible tool for any developer who wants to leverage the power of AI in their daily workflow. It's a versatile tool that can help you with a wide range of programming tasks, from generating code and automating tasks to interacting with various AI models. 16 | 17 | ### Key Features 18 | 19 | * **Agent Orchestration:** Switch between different coding agents, and orchestrate multiple agents in parallel or sequence. 20 | * **Rapid Code Review:** Quickly review code and start development servers. 21 | * **Task Tracking:** Track the status of tasks assigned to agents. 22 | * **Centralized Configuration:** Centralize agent configuration for easy management. 23 | 24 | ## Installation 25 | 26 | ```bash 27 | npx vibe-kanban 28 | ``` 29 | 30 | ## Quickstart 31 | 32 | 1. Run `npx vibe-kanban` in your terminal. 33 | 2. The Vibe Kanban board will open in your browser. 34 | 3. Start adding tasks and assigning them to your AI coding agents. 35 | 36 | ## Links 37 | 38 | * **Website:** https://vibekanban.com 39 | * **GitHub:** https://github.com/BloopAI/vibe-kanban 40 | 41 | ## Tutorials 42 | 43 | * **Official Documentation:** https://vibekanban.com 44 | -------------------------------------------------------------------------------- /docs/zed.md: -------------------------------------------------------------------------------- 1 | --- 2 | tags: 3 | - editor 4 | --- 5 | 6 | # Zed 7 | 8 | | Website | GitHub | License | 9 | | --- | --- | --- | 10 | | [zed.dev](https://zed.dev/) | [zed-industries/zed](https://github.com/zed-industries/zed) | Apache 2.0 / Zed License | 11 | 12 | **Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.** 13 | 14 | Zed is a modern code editor written in Rust, designed for speed and efficiency. It offers a streamlined, minimalist interface while providing powerful features for individual developers and collaborative teams. 15 | 16 | ### Key Features 17 | 18 | * **Performance:** Built in Rust, Zed leverages your hardware to provide a fast and responsive coding experience. 19 | * **Collaboration:** Real-time collaboration is a core feature, allowing you to code with others in a shared workspace. 20 | * **Language Support:** Zed has out-of-the-box support for many languages, using the Language Server Protocol (LSP) for features like autocompletion and diagnostics. 21 | * **Git Integration:** It features first-class Git integration, allowing you to manage your source control from within the editor. 22 | * **AI Integration:** Zed is building in features for AI-assisted development, including code generation and analysis. 23 | * **Minimalist UI:** The user interface is designed to be clean and unobtrusive, keeping the focus on your code. 24 | 25 | ## Installation 26 | 27 | Zed is available for macOS and Linux. You can download it from the official website. 28 | 29 | ## Links 30 | 31 | * **Website:** https://zed.dev/ 32 | * **GitHub:** https://github.com/zed-industries/zed 33 | * **Documentation:** https://zed.dev/docs 34 | * **Blog:** https://zed.dev/blog -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | # The Community Guide to Open-Source AI Software Craft 3 | 4 | **[oss-ai-swe.org](https://oss-ai-swe.org/)** 5 | 6 | Welcome to the Community Guide to Open-Source AI Software Craft! This project is a collaborative, open-source guide and knowledge base for software engineers working with open-source AI tools and workflows. Our goal is to help the community share best practices, tools, and insights for building, maintaining, and contributing to open-source AI software tools. 7 | 8 | --- 9 | 10 | ## 🌐 About the Website 11 | 12 | This website is built using [MkDocs](https://www.mkdocs.org/) and is designed to be easy to read, search, and contribute to. It serves as a living document for: 13 | 14 | - Guides and tutorials for open-source AI development 15 | - Tool and library overviews 16 | - Best practices and workflows 17 | - Community-contributed tips and resources 18 | 19 | You can browse the site online or build it locally to preview your changes. 20 | 21 | --- 22 | 23 | ## 🚀 How It Works 24 | 25 | The site is powered by MkDocs, a static site generator for project documentation. All content lives in the `docs/` directory as Markdown files. The navigation and site configuration are managed in `mkdocs.yml`. 26 | 27 | **Key files and folders:** 28 | 29 | - `docs/` — All documentation content (Markdown files) 30 | - `mkdocs.yml` — Site configuration and navigation 31 | - `stylesheets/extra.css` — Custom styles 32 | 33 | To view the site locally: 34 | 35 | ```sh 36 | pip install mkdocs 37 | mkdocs serve 38 | ``` 39 | Then open [http://localhost:8000](http://localhost:8000) in your browser. 40 | 41 | --- 42 | 43 | ## 🛠️ How to Update the Website 44 | 45 | 1. **Edit or add Markdown files** in the `docs/` directory. Each file becomes a page on the site. 46 | 2. **Update `mkdocs.yml`** to add new pages to the navigation. 47 | 3. **Preview locally** with `mkdocs serve`. 48 | 4. **Commit your changes** and open a pull request (see below). 49 | 50 | --- 51 | 52 | ## 🤝 Contributing 53 | 54 | We welcome contributions from everyone! Whether you want to fix a typo, add a new guide, or suggest improvements, your help is appreciated. 55 | 56 | ### How to Contribute 57 | 58 | 1. **Check open issues** or [open a new one](https://github.com/intellectronica/oss-ai-swe/issues) to discuss your idea. 59 | 2. **Fork the repository** and create a new branch for your changes. 60 | 3. **Make your edits** (see above for how to update the site). 61 | 4. **Open a pull request** with a clear description of your changes. 62 | 5. **Participate in code review** and update your PR as needed. 63 | 64 | --- 65 | 66 | ## 📬 Questions & Feedback 67 | 68 | If you have questions, suggestions, or want to get involved, please open an issue or join the discussion on GitHub. 69 | 70 | Thank you for helping make open-source AI software better for everyone! 71 | -------------------------------------------------------------------------------- /docs/amazon-q-cli.md: -------------------------------------------------------------------------------- 1 | --- 2 | tags: 3 | - cli 4 | --- 5 | 6 | # Amazon Q CLI 7 | 8 | | Website | GitHub | License | 9 | | --- | --- | --- | 10 | | [aws.amazon.com/q](https://aws.amazon.com/q/) | [aws/amazon-q-developer-cli](https://github.com/aws/amazon-q-developer-cli) | Apache 2.0 & MIT | 11 | 12 | **Amazon Q CLI (also known simply as `q`) is a command-line companion that brings Amazon Q’s AI-powered chat and autocompletion features to your terminal.** 13 | 14 | With `q` you can have a natural-language conversation, translate plain-English requests into shell commands, and receive inline completions for more than 500 popular CLIs such as `git`, `docker`, and `aws`. 15 | 16 | ### Key Features 17 | 18 | * **`q chat` interactive mode:** Ask questions and get answers directly in the terminal. 19 | * **Command generation & translation:** Convert natural-language instructions into executable shell commands. 20 | * **Inline completions:** Context-aware suggestions as you type, based on your shell history and current directory. 21 | * **Git-aware context:** Includes file diffs and project structure to refine answers and code suggestions. 22 | * **Profiles & hooks:** Fine-grained control over what context is shared, with the ability to extend via custom hooks. 23 | 24 | ## Installation 25 | 26 | Below is a condensed overview. See the [official installation guide](https://docs.aws.amazon.com/amazonq/latest/qdeveloper-ug/command-line-installing.html) for full details. 27 | 28 | ### macOS (Homebrew) 29 | 30 | ```bash 31 | brew tap aws/tap 32 | brew install amazon-q-cli 33 | ``` 34 | 35 | Alternatively, download the signed **Amazon Q.dmg** and drag the app to _Applications_. Launch once to enable shell integrations. 36 | 37 | ### Linux AppImage 38 | 39 | ```bash 40 | curl -LO https://desktop-release.q.us-east-1.amazonaws.com/latest/amazon-q.appimage 41 | chmod +x amazon-q.appimage 42 | ./amazon-q.appimage 43 | ``` 44 | 45 | For headless servers, download the minimal zip that contains only the `q` and `qterm` binaries. 46 | 47 | ### Ubuntu / Debian package 48 | 49 | ```bash 50 | wget https://desktop-release.q.us-east-1.amazonaws.com/latest/amazon-q_amd64.deb 51 | sudo apt install ./amazon-q_amd64.deb 52 | ``` 53 | 54 | ## Quickstart 55 | 56 | 1. Authenticate: 57 | 58 | ```bash 59 | q login 60 | ``` 61 | 62 | Sign in with your **AWS Builder ID** or **IAM Identity Center** credentials. 63 | 2. Start a chat session inside your project: 64 | 65 | ```bash 66 | q chat 67 | ``` 68 | 3. For inline completions, ensure the installer added the appropriate hook to your shell (`zsh`, `bash`, or `fish`). 69 | 70 | ## Links 71 | 72 | * **Docs – Using Q on the command line:** 73 | * **CLI reference:** 74 | * **GitHub:** 75 | * **Supported environments:** 76 | -------------------------------------------------------------------------------- /docs/ruler.md: -------------------------------------------------------------------------------- 1 | --- 2 | tags: 3 | - cli 4 | - util 5 | --- 6 | 7 | # Ruler 8 | 9 | | Website | GitHub | License | 10 | | --- | --- | --- | 11 | | [ai.intellectronica.net/ruler](https://ai.intellectronica.net/ruler) | [intellectronica/ruler](https://github.com/intellectronica/ruler) | MIT | 12 | 13 | **Ruler is a command-line tool designed to manage and synchronize instructions for various AI coding assistants.** 14 | 15 | Ruler is a command-line tool that helps you to manage and synchronize instructions for various AI coding assistants. As teams grow, managing the configurations for different AI agents like GitHub Copilot, Claude, and others can lead to inconsistencies. Ruler addresses this by providing a single source of truth for all AI agent instructions, distributing them to the correct configuration files. 16 | 17 | ### Key Features 18 | 19 | * **Centralized Rule Management:** Ruler allows you to store all of your AI instructions in a dedicated `.ruler/` directory. This makes it easy to manage and version your instructions, and it ensures that everyone on your team is using the same set of rules. 20 | * **Automatic Distribution:** Ruler automatically applies your rules to the configuration files of supported AI agents. This saves you the time and effort of having to manually update the configuration files for each tool. 21 | * **Simplified Onboarding:** Ruler makes it easier to onboard new AI tools into your project. Instead of having to manually configure each tool, you can simply add a new configuration file to your `.ruler/` directory and Ruler will take care of the rest. 22 | * **Extensibility:** Ruler is designed to be extensible, allowing you to add support for new AI tools and to create custom rules and configurations. This makes it a flexible tool that can be adapted to a wide variety of workflows. 23 | 24 | Ruler is a powerful and flexible tool for any team that is using multiple AI coding assistants. Its ability to centralize and synchronize instructions, its automatic distribution capabilities, and its extensibility make it a valuable addition to any team's toolkit. 25 | 26 | ## Installation 27 | 28 | ### npm 29 | 30 | ```bash 31 | npm install -g @intellectronica/ruler 32 | ``` 33 | 34 | ### npx 35 | 36 | ```bash 37 | npx @intellectronica/ruler 38 | ``` 39 | 40 | ## Quickstart 41 | 42 | 1. Install Ruler using one of the methods above. 43 | 2. Navigate to your project's root directory. 44 | 3. Initialize Ruler: 45 | ```bash 46 | ruler init 47 | ``` 48 | 4. This will create a `.ruler/` directory with configuration files. 49 | 5. Add your coding rules to the `instructions.md` file. 50 | 6. Apply the rules to your AI agents: 51 | ```bash 52 | ruler apply 53 | ``` 54 | 55 | ## Links 56 | 57 | * **GitHub:** https://github.com/intellectronica/ruler 58 | * **npm:** https://www.npmjs.com/package/@intellectronica/ruler 59 | 60 | ## Tutorials 61 | 62 | * **Ruler: Centralise Your AI Coding Assistant Instructions** — [https://ai.intellectronica.net/ruler](https://ai.intellectronica.net/ruler) 63 | * **Ruler – GitHub README** — [https://github.com/intellectronica/ruler](https://github.com/intellectronica/ruler) 64 | * **AI-Assisted Software Engineering in the Large (uses Ruler)** — [https://ai.intellectronica.net/ai-assisted-software-engineering-in-the-large](https://ai.intellectronica.net/ai-assisted-software-engineering-in-the-large) 65 | 66 | > **Tip:** Some tools (notably **Ruler**) are brand-new, so community video walk-throughs are still scarce. The textual guides above cover setup and workflow comprehensively until video demos emerge. 67 | -------------------------------------------------------------------------------- /docs/llm.md: -------------------------------------------------------------------------------- 1 | --- 2 | tags: 3 | - cli 4 | - util 5 | --- 6 | 7 | # LLM 8 | 9 | | Website | GitHub | License | 10 | | --- | --- | --- | 11 | | [llm.datasette.io](https://llm.datasette.io/) | [simonw/llm](https://github.com/simonw/llm) | Apache 2.0 | 12 | 13 | **LLM is a command-line tool and Python library for interacting with large language models.** 14 | 15 | LLM is a powerful and versatile tool for interacting with large language models from the command line. Created by Simon Willison, co-creator of Django, it provides a unified interface for working with a wide range of models, including those from OpenAI, Anthropic, Google, and Meta. It's designed with the Unix philosophy of composable tools in mind, allowing it to be piped with other command-line utilities. 16 | 17 | ### Key Features 18 | 19 | * **Unified Interface for Multiple Models:** LLM provides a single, consistent interface for interacting with a wide range of large language models. This means you can use the same commands and syntax to work with models from different providers, making it easy to switch between them. 20 | * **Extensible Plugin System:** LLM has an extensible plugin system that allows you to add support for new models and to create custom commands and integrations. This makes it a flexible tool that can be adapted to a wide variety of workflows. 21 | * **Composable Command-Line Tool:** LLM is designed to be a composable command-line tool, which means it can be piped with other command-line utilities. This allows you to create powerful and complex workflows by combining LLM with other tools. 22 | * **Conversation History and Embeddings:** LLM provides features for managing your conversation history, storing your prompts and responses in a SQLite database. It also allows you to work with embeddings, which can be used for a variety of tasks, such as semantic search and clustering. 23 | 24 | LLM is a powerful and flexible tool for any developer who wants to leverage the power of large language models from the command line. Its unified interface, its extensible plugin system, and its composable design make it a valuable addition to any developer's toolkit. 25 | 26 | ## Installation 27 | 28 | ### pip 29 | 30 | ```bash 31 | pip install llm 32 | ``` 33 | 34 | ### Homebrew 35 | 36 | ```bash 37 | brew install llm 38 | ``` 39 | 40 | ### pipx 41 | 42 | ```bash 43 | pipx install llm 44 | ``` 45 | 46 | ## Quickstart 47 | 48 | 1. Install `llm` using one of the methods above. 49 | 2. Set up an API key for the language model you want to use. For example, for OpenAI: 50 | ```bash 51 | llm keys set openai 52 | ``` 53 | 3. Run a prompt: 54 | ```bash 55 | llm "Ten fun names for a pet pelican" 56 | ``` 57 | 58 | ## Links 59 | 60 | * **Website:** https://llm.datasette.io/ 61 | * **GitHub:** https://github.com/simonw/llm 62 | * **Plugins:** https://llm.datasette.io/en/latest/plugins/directory.html 63 | 64 | ## Tutorials 65 | 66 | * **LLM Usage Guide** — [https://llm.datasette.io/en/stable/usage.html](https://llm.datasette.io/en/stable/usage.html) 67 | * **CLI Reference** — [https://llm.datasette.io/en/stable/help.html](https://llm.datasette.io/en/stable/help.html) 68 | * **Language Models on the Command Line** — [https://simonwillison.net/2024/Jun/17/cli-language-models/](https://simonwillison.net/2024/Jun/17/cli-language-models/) 69 | * **Using LLM on the Command Line** (YouTube) — [https://www.youtube.com/watch?v=aQuuJuCa0VM](https://www.youtube.com/watch?v=aQuuJuCa0VM) 70 | * **LLM 0.26 – Running Tools with LLM** — [https://simonwillison.net/2025/May/27/llm-tools/](https://simonwillison.net/2025/May/27/llm-tools/) 71 | -------------------------------------------------------------------------------- /docs/cline.md: -------------------------------------------------------------------------------- 1 | --- 2 | tags: 3 | - vscode 4 | --- 5 | 6 | # Cline 7 | 8 | | Website | GitHub | License | 9 | | --- | --- | --- | 10 | | [cline.bot](https://www.cline.bot/) | [cline/cline](https://github.com/cline/cline) | Apache 2.0 | 11 | 12 | **Cline is an AI-powered coding assistant that works as a Visual Studio Code extension. It helps developers write code more efficiently by providing intelligent code suggestions, automating tasks, and integrating with various AI models.** 13 | 14 | Cline is a powerful and flexible AI coding assistant that is designed to be a seamless extension of your Visual Studio Code environment. It's a versatile tool that can help you with a wide range of programming tasks, from generating code and automating tasks to interacting with various AI models. The tool is built with a focus on extensibility, allowing you to customize it to fit your specific needs. 15 | 16 | ### Key Features 17 | 18 | * **Visual Studio Code Integration:** Cline is a Visual Studio Code extension, which means it is deeply integrated into your development environment. This allows it to provide context-aware assistance and to be a seamless part of your workflow. 19 | * **Model Flexibility:** Cline supports multiple AI models, including those from Anthropic (Claude), OpenAI (GPT), and Google (Gemini). This gives you the flexibility to choose the best model for your needs, or even to use multiple models for different tasks. 20 | * **Extensibility:** Cline is designed to be extensible, allowing you to create custom tools to fit your workflow. This means you can add new commands, integrations, and features to the tool to fit your specific needs. 21 | * **File and Command Execution:** Cline can create and edit files, showing you a diff of the changes, and can run commands in your terminal. This makes it a powerful tool for automating a wide range of tasks. 22 | 23 | Cline is a powerful and flexible tool for any developer who wants to leverage the power of AI in their daily workflow. Its deep integration with Visual Studio Code, its support for multiple AI models, and its extensibility make it a valuable addition to any developer's toolkit. 24 | 25 | ## Installation 26 | 27 | 1. Open VS Code. 28 | 2. Go to the Extensions view (click the Extensions icon in the Activity Bar). 29 | 3. Search for "Cline" and click "Install". 30 | 4. Reload VS Code. 31 | 32 | ## Quickstart 33 | 34 | 1. After installation, click the Cline icon in the Activity Bar or use `CMD/CTRL + Shift + P` and search for "Cline". 35 | 2. Create a Cline account to get an API key. 36 | 3. Start a conversation with Cline by typing your request in natural language. 37 | 38 | ## Links 39 | 40 | * **Website:** https://cline.bot/ 41 | * **GitHub:** https://github.com/cline/cline 42 | * **Discord:** https://discord.gg/cline 43 | * **Blog:** https://cline.bot/blog 44 | 45 | ## Tutorials 46 | 47 | * **Getting started – For New Coders** — [https://docs.cline.bot/getting-started/for-new-coders](https://docs.cline.bot/getting-started/for-new-coders) 48 | * **How to Set Up Cline: A Beginner’s Step-by-Step Guide** — [https://apidog.com/blog/how-to-use-cline/](https://apidog.com/blog/how-to-use-cline/) 49 | * **How to Use Cline Coding Agent for Free** (YouTube) — [https://www.youtube.com/watch?v=SjYnmDjMBWc](https://www.youtube.com/watch?v=SjYnmDjMBWc) 50 | * **Cline + VS Code Changed How I Code Forever** (YouTube) — [https://www.youtube.com/watch?v=KjqQC4AnJ1I](https://www.youtube.com/watch?v=KjqQC4AnJ1I) 51 | * **An Introduction to My Daily Coding Assistant and How I Use It** — [https://medium.com/@colin.nardo/an-introduction-to-my-daily-coding-assistant-and-how-i-use-it-1669aaa9c34f](https://medium.com/@colin.nardo/an-introduction-to-my-daily-coding-assistant-and-how-i-use-it-1669aaa9c34f) 52 | -------------------------------------------------------------------------------- /docs/open-code.md: -------------------------------------------------------------------------------- 1 | --- 2 | tags: 3 | - cli 4 | --- 5 | 6 | # opencode 7 | 8 | | Website | GitHub | License | Tags | 9 | | --- | --- | --- | --- | 10 | | [opencode.ai](https://opencode.ai/) | [sst/opencode](https://github.com/sst/opencode) | MIT | `cli` | 11 | 12 | **opencode is a terminal-based AI coding assistant that helps you with a variety of tasks, such as answering questions about your code, generating new code, and debugging and fixing errors.** 13 | 14 | opencode is a powerful and flexible AI coding assistant that runs in your terminal. It's designed to be a versatile tool that can help you with a wide range of programming tasks, from answering simple questions to generating complex code. The tool is built with a modular architecture, which allows it to be easily extended and customized to fit your specific needs. 15 | 16 | ### Key Features 17 | 18 | * **Terminal-Based Interface:** A responsive, native, themeable terminal UI. 19 | * **Multiple AI Models:** Supports 75+ LLM providers through [Models.dev](https://models.dev/), including local models.. 20 | * **Language Server Protocol Integration:** opencode natively supports many LSP Servers which means that, if a edit introduced any syntax or langauge specific errors they get feed directly back into the LLM. 21 | * **Client/Server Architecture:** opencode uses a client/server architecture, which allows you to run the AI model on a separate machine from your development machine. This can be useful for a variety of reasons, such as if you want to have multiple Agents run on the same Project. 22 | * **Sharable Links:** share your opencode session with other developers to show them your work or for debug purposes. 23 | 24 | opencode is a powerful and flexible tool for any developer who wants to leverage the power of AI in their daily workflow. Its terminal-based interface, its support for multiple AI models, and its modular architecture make it a valuable addition to any developer's toolkit. 25 | 26 | ## Installation 27 | 28 | ### Install Script 29 | 30 | ```bash 31 | curl -fsSL https://opencode.ai/install | bash 32 | ``` 33 | 34 | ### Homebrew 35 | 36 | ```bash 37 | brew install sst/tap/opencode 38 | ``` 39 | 40 | ### npm 41 | 42 | ```bash 43 | npm install -g opencode-ai 44 | ``` 45 | 46 | ## Quickstart 47 | 48 | 1. Install OpenCode using one of the methods above. 49 | 2. Run the interactive TUI: 50 | ```bash 51 | opencode 52 | ``` 53 | 3. Log in to your preferred AI provider: 54 | ```bash 55 | opencode auth login 56 | ``` 57 | 4. Start a new session and interact with the AI. 58 | 59 | ## Links 60 | 61 | * **Website:** https://opencode.ai/ 62 | * **GitHub:** https://github.com/opencode-ai/opencode 63 | * **Docs:** https://docs.opencode.ai/ 64 | 65 | ## Tutorials 66 | 67 | * **This CLI Tool Changed Coding Forever! (OpenCode)** (YouTube) — [https://www.youtube.com/watch?v=YLNAp4_AUpo](https://www.youtube.com/watch?v=YLNAp4_AUpo) 68 | * **OpenCode: NEW Agentic AI Coder** (YouTube) — [https://www.youtube.com/watch?v=Z0HglpK20ec](https://www.youtube.com/watch?v=Z0HglpK20ec) 69 | * **How I Built an AI-Powered Terminal That Costs Me Nothing** — [https://medium.com/@PowerUpSkills/how-i-built-an-ai-powered-terminal-that-costs-me-nothing-2a64ac1e0312](https://medium.com/@PowerUpSkills/how-i-built-an-ai-powered-terminal-that-costs-me-nothing-2a64ac1e0312) 70 | * **Building Your Ultimate Terminal-Based AI Coding Assistant** — [https://atalupadhyay.wordpress.com/2025/06/16/open-code-building-your-ultimate-terminal-based-ai-coding-assistant/](https://atalupadhyay.wordpress.com/2025/06/16/open-code-building-your-ultimate-terminal-based-ai-coding-assistant/) 71 | * **OpenCode: The ULTIMATE AI Coding Agent** (YouTube) — [https://www.youtube.com/watch?v=SIhToEaIsjQ](https://www.youtube.com/watch?v=SIhToEaIsjQ) 72 | -------------------------------------------------------------------------------- /docs/open-hands.md: -------------------------------------------------------------------------------- 1 | --- 2 | tags: 3 | - cli 4 | --- 5 | 6 | # OpenHands 7 | 8 | | Website | GitHub | License | 9 | | --- | --- | --- | 10 | | [all-hands.dev](https://www.all-hands.dev/) | [All-Hands-AI/OpenHands](https://github.com/All-Hands-AI/OpenHands) | MIT | 11 | 12 | **OpenHands is an open-source platform for creating and deploying AI agents that can perform software development tasks like a human developer.** 13 | 14 | OpenHands is a powerful and flexible platform for building and deploying AI agents that can perform a wide range of software development tasks. It's designed to be a collaborative tool, allowing you to work with AI agents to write and modify code, run commands, browse the web, and interact with APIs. The goal of OpenHands is to improve development efficiency by automating repetitive coding tasks, assisting with code generation, debugging, and testing. 15 | 16 | ### Key Features 17 | 18 | * **Autonomous Agents:** OpenHands allows you to create and deploy autonomous agents that can perform a wide range of software development tasks. These agents can navigate codebases, test changes, and resolve issues on their own, freeing you up to focus on more complex and creative work. 19 | * **LLM Support:** OpenHands supports a variety of large language models, giving you the flexibility to choose the best model for your needs. It also provides a sandboxed environment for agent development and deployment, ensuring that your code and data are secure. 20 | * **Integration with Existing Tools:** The platform is designed to integrate with your existing development tools and workflows. This means you can use OpenHands with your favorite IDE, version control system, and other tools without having to change your workflow. 21 | * **Community-Driven:** OpenHands is a community-driven project, with contributions from both academia and industry. This means that the platform is constantly evolving and improving, with new features and capabilities being added all the time. 22 | 23 | OpenHands is a powerful and flexible platform for any developer who wants to leverage the power of AI to automate their workflow. Its ability to create and deploy autonomous agents, its support for a variety of LLMs, and its integration with existing tools make it a valuable addition to any developer's toolkit. 24 | 25 | ## Installation 26 | 27 | ### Docker 28 | 29 | The easiest way to get started with OpenHands is by using Docker. 30 | 31 | ```bash 32 | docker run -p 3000:3000 allhandsai/openhands 33 | ``` 34 | 35 | ## Quickstart 36 | 37 | 1. Install OpenHands using Docker. 38 | 2. Access the OpenHands UI by navigating to `http://localhost:3000` in your web browser. 39 | 3. Select a Large Language Model (LLM) provider and enter your API key. 40 | 4. Start a new session and provide a prompt to the AI agent. 41 | 42 | ## Links 43 | 44 | * **Website:** https://www.all-hands.dev/ 45 | * **GitHub:** https://github.com/All-Hands-AI/OpenHands 46 | * **Docs:** https://docs.all-hands.dev/ 47 | 48 | ## Tutorials 49 | 50 | * **OpenHands Docs – Getting Started** — [https://docs.all-hands.dev/usage/getting-started](https://docs.all-hands.dev/usage/getting-started) 51 | * **This AI Agent Built an App While I Watched (OpenHands)** (YouTube) — [https://www.youtube.com/watch?v=DPtOIljNmOg](https://www.youtube.com/watch?v=DPtOIljNmOg) 52 | * **OpenHands + Daytona = Zero-to-Hero** (YouTube) — [https://www.youtube.com/watch?v=4D3ctTcB2hY](https://www.youtube.com/watch?v=4D3ctTcB2hY) 53 | * **OpenHands: Open-Source AI Software Developer** — [https://www.kdnuggets.com/openhands-open-source-ai-software-developer](https://www.kdnuggets.com/openhands-open-source-ai-software-developer) 54 | * **OpenHands AI Agent Quick-Start (Short video)** — [https://www.youtube.com/shorts/wgD3PfwXYi0](https://www.youtube.com/shorts/wgD3PfwXYi0) 55 | -------------------------------------------------------------------------------- /docs/roocode.md: -------------------------------------------------------------------------------- 1 | --- 2 | tags: 3 | - vscode 4 | --- 5 | 6 | # RooCode 7 | 8 | | Website | GitHub | License | 9 | | --- | --- | --- | 10 | | [roocode.com](https://roocode.com/) | [RooCodeInc/Roo-Code](https://github.com/RooCodeInc/Roo-Code) | Apache 2.0 | 11 | 12 | **RooCode is an open-source AI coding assistant that functions as a VS Code extension. It provides agentic AI capabilities, allowing it to understand your entire codebase, and read and write files across your project.** 13 | 14 | RooCode is a powerful and flexible AI coding assistant that is designed to be a seamless extension of your Visual Studio Code environment. It's a versatile tool that can help you with a wide range of programming tasks, from generating code and automating tasks to understanding your entire codebase. The tool is built with a focus on being model-agnostic, allowing you to use it with a variety of AI models. 15 | 16 | ### Key Features 17 | 18 | * **Visual Studio Code Integration:** RooCode is a Visual Studio Code extension, which means it is deeply integrated into your development environment. This allows it to provide context-aware assistance and to be a seamless part of your workflow. 19 | * **Agentic AI Capabilities:** RooCode has agentic AI capabilities, which means it can understand your entire codebase and read and write files across your project. This allows it to perform complex tasks that require a deep understanding of your code. 20 | * **Model-Agnostic:** RooCode is model-agnostic, which means you can use it with a variety of AI models, including those from OpenAI, Anthropic, or local models. This gives you the flexibility to choose the best model for your needs, or even to use multiple models for different tasks. 21 | * **Open Source:** RooCode is an open-source project, which means that you can inspect the code, contribute to the project, and even host it yourself. This makes it a transparent and trustworthy tool that you can rely on. 22 | 23 | RooCode is a powerful and flexible tool for any developer who wants to leverage the power of AI in their daily workflow. Its deep integration with Visual Studio Code, its agentic AI capabilities, and its model-agnostic design make it a valuable addition to any developer's toolkit. 24 | 25 | ## Installation 26 | 27 | 1. Open VS Code. 28 | 2. Go to the Extensions view (click the Extensions icon in the Activity Bar). 29 | 3. Search for "RooCode" and click "Install". 30 | 4. Reload VS Code. 31 | 32 | ## Quickstart 33 | 34 | 1. After installing the extension, click the RooCode icon in the Activity Bar. 35 | 2. Select an API provider and enter your API key. 36 | 3. Start a conversation with RooCode by typing your request in natural language. 37 | 38 | ## Links 39 | 40 | * **Website:** https://roocode.com/ 41 | * **GitHub:** https://github.com/RooCodeInc/Roo-Code 42 | * **Docs:** https://docs.roocode.com/ 43 | 44 | ## Tutorials 45 | 46 | * **Roo Code – VS Code Marketplace Page (setup docs)** — [https://marketplace.visualstudio.com/items?itemName=RooVeterinaryInc.roo-cline](https://marketplace.visualstudio.com/items?itemName=RooVeterinaryInc.roo-cline) 47 | * **Free AI Coding Assistant: Setup Roo Code with Free LLM Models** — [https://medium.com/four-nine-digital/free-ai-coding-assistant-setup-up-roo-code-with-free-llm-models-04beca21793d](https://medium.com/four-nine-digital/free-ai-coding-assistant-setup-up-roo-code-with-free-llm-models-04beca21793d) 48 | * **Roo Code is AMAZING – AI VS Code Extension** (YouTube) — [https://www.youtube.com/watch?v=r5T3h0BOiWw](https://www.youtube.com/watch?v=r5T3h0BOiWw) 49 | * **Your Ultimate AI Coding Agent: Roo Code + VS Code** (YouTube) — [https://www.youtube.com/watch?v=hRxjMTyB-GA](https://www.youtube.com/watch?v=hRxjMTyB-GA) 50 | * **Installing Roo Code in VS Code – Quick Setup** (YouTube) — [https://www.youtube.com/watch?v=Mcq3r1EPZ-4](https://www.youtube.com/watch?v=Mcq3r1EPZ-4) 51 | -------------------------------------------------------------------------------- /docs/gemini-cli.md: -------------------------------------------------------------------------------- 1 | --- 2 | tags: 3 | - cli 4 | --- 5 | 6 | # Gemini CLI 7 | 8 | | Website | GitHub | License | 9 | | --- | --- | --- | 10 | | [cloud.google.com/gemini/docs/codeassist/gemini-cli](https://cloud.google.com/gemini/docs/codeassist/gemini-cli) | [google-gemini/gemini-cli](https://github.com/google-gemini/gemini-cli) | Apache 2.0 | 11 | 12 | **Gemini CLI is a command-line interface from Google that allows you to interact with the Gemini family of models. It's a powerful tool for developers who want to leverage the capabilities of Gemini for a wide range of software engineering tasks.** 13 | 14 | Gemini CLI is designed to be a versatile and powerful tool for developers, providing access to Google's advanced AI models directly from the terminal. It can be used for a variety of tasks, from answering questions and generating code to automating complex workflows. The tool is built with developers in mind, offering a seamless way to integrate the power of Gemini into their daily work. 15 | 16 | ### Key Features 17 | 18 | * **Direct Access to Gemini Models:** The primary feature of Gemini CLI is its ability to provide direct access to the Gemini family of models. This allows you to leverage the power of these models for a wide range of tasks without needing to use a web-based interface. 19 | * **Code Generation and Understanding:** Gemini CLI can be used to generate code snippets, write entire functions, and even create new applications from scratch. It can also be used to understand existing codebases, providing explanations of complex code in natural language. 20 | * **Automation of Operational Tasks:** Beyond just coding, Gemini CLI can be used to automate a variety of operational tasks. This can include things like writing scripts, managing infrastructure, and interacting with other tools and services. 21 | * **Extensibility:** Gemini CLI is designed to be extensible, allowing you to create custom commands and integrations to suit your specific needs. This makes it a flexible tool that can be adapted to a wide variety of workflows. 22 | 23 | Gemini CLI is a powerful tool for any developer looking to leverage the power of Google's Gemini models. Its ability to interact with your code, automate tasks, and provide access to advanced AI capabilities makes it a valuable addition to any developer's toolkit. 24 | 25 | ## Installation 26 | 27 | ### npx 28 | 29 | ```bash 30 | npx https://github.com/google-gemini/gemini-cli 31 | ``` 32 | 33 | ### npm 34 | 35 | ```bash 36 | npm install -g @google/gemini-cli 37 | ``` 38 | 39 | ## Quickstart 40 | 41 | 1. Install `gemini-cli` using one of the methods above. 42 | 2. Run the interactive CLI: 43 | ```bash 44 | gemini 45 | ``` 46 | 3. The first time you run it, you will be prompted to log in with your Google account. 47 | 4. After logging in, you can start a conversation with Gemini. 48 | 49 | ## Links 50 | 51 | * **GitHub:** https://github.com/google-gemini/gemini-cli 52 | 53 | ## Tutorials 54 | 55 | * **Gemini CLI – Google Cloud Docs** — [https://cloud.google.com/gemini/docs/codeassist/gemini-cli](https://cloud.google.com/gemini/docs/codeassist/gemini-cli) 56 | * **Introducing Gemini CLI (Google Blog)** — [https://blog.google/technology/developers/introducing-gemini-cli-open-source-ai-agent/](https://blog.google/technology/developers/introducing-gemini-cli-open-source-ai-agent/) 57 | * **Gemini CLI Tutorial: How to Install and Use It** — [https://dev.to/auden/google-gemini-cli-tutorial-how-to-install-and-use-it-with-images-4phb](https://dev.to/auden/google-gemini-cli-tutorial-how-to-install-and-use-it-with-images-4phb) 58 | * **Google Gemini CLI: AI in Your Terminal** (YouTube) — [https://www.youtube.com/watch?v=xqvprnPocHs](https://www.youtube.com/watch?v=xqvprnPocHs) 59 | * **Gemini CLI: First Look at Google’s FREE AI Agent** (YouTube) — [https://www.youtube.com/watch?v=Pwx7_DLGYAc](https://www.youtube.com/watch?v=Pwx7_DLGYAc) 60 | -------------------------------------------------------------------------------- /docs/goose.md: -------------------------------------------------------------------------------- 1 | --- 2 | tags: 3 | - cli 4 | - gui 5 | --- 6 | 7 | # Goose 8 | 9 | | Website | GitHub | License | 10 | | --- | --- | --- | 11 | | [block.github.io/goose](https://block.github.io/goose/) | [block/goose](https://github.com/block/goose) | Apache 2.0 | 12 | 13 | **Goose is a local, extensible, open source AI agent that automates engineering tasks from start to finish.** 14 | 15 | Goose is your on-machine AI agent, capable of automating complex development tasks autonomously. More than just code suggestions, Goose can build entire projects from scratch, write and execute code, debug failures, orchestrate workflows, and interact with external APIs. Whether you're prototyping an idea, refining existing code, or managing intricate engineering pipelines, Goose adapts to your workflow and executes tasks with precision. 16 | 17 | ### Key Features 18 | 19 | * **Autonomous Development Tasks:** Goose can build entire projects from scratch, write and execute code, debug failures, and manage complex engineering workflows without requiring constant supervision. 20 | * **Multi-LLM Support:** Designed for maximum flexibility, Goose works with any LLM and supports multi-model configuration to optimize performance and cost for different types of tasks. 21 | * **MCP Server Integration:** Seamlessly integrates with MCP (Model Context Protocol) servers, allowing for extended functionality and integration with external tools and APIs. 22 | * **Dual Interface Options:** Available as both a desktop application and a command-line interface, making it accessible for different developer preferences and workflows. 23 | * **Local and Extensible:** Runs locally on your machine for privacy and security, while being extensible through its open architecture to adapt to your specific development needs. 24 | 25 | Goose is a powerful and flexible tool for any developer who wants to leverage autonomous AI assistance in their daily workflow. Its ability to handle complete development tasks, multi-model support, and availability in both GUI and CLI formats make it a comprehensive solution for AI-assisted software engineering. 26 | 27 | ## Installation 28 | 29 | ### CLI 30 | 31 | The Goose CLI can be installed using `pipx`. 32 | 33 | ```bash 34 | pipx install goose-ai 35 | ``` 36 | 37 | ### Desktop App 38 | 39 | A desktop application is available for Mac and Windows. You can download it from the [Goose website](https://block.github.io/goose/docs/install). 40 | 41 | ## Quickstart 42 | 43 | 1. Install Goose using one of the methods above. 44 | 2. Configure Goose with your preferred LLM by obtaining the necessary API keys. 45 | 3. Start a Goose session: 46 | ```bash 47 | goose session start 48 | ``` 49 | 4. Interact with the AI agent to automate tasks. 50 | 51 | ## Links 52 | 53 | * **Website:** https://block.github.io/goose/ 54 | * **GitHub:** https://github.com/block/goose 55 | * **Documentation:** https://block.github.io/goose/docs/intro 56 | 57 | ## Tutorials 58 | 59 | * **Goose in 5 Minutes – Quickstart** — [https://block.github.io/goose/docs/quickstart/](https://block.github.io/goose/docs/quickstart/) 60 | * **Introducing Goose, the On-Machine AI Agent** — [https://blog.marcnuri.com/goose-on-machine-ai-agent-cli-introduction](https://blog.marcnuri.com/goose-on-machine-ai-agent-cli-introduction) 61 | * **Coding with Goose, an AI Agent** (YouTube) — [https://www.youtube.com/watch?v=NPuxzX5rdjk](https://www.youtube.com/watch?v=NPuxzX5rdjk) 62 | * **Codename Goose – Build Your AI Agents** (YouTube) — [https://www.youtube.com/watch?v=7NmEKaX44L4](https://www.youtube.com/watch?v=7NmEKaX44L4) 63 | * **Integrating Ollama with Goose – Comprehensive Guide** — [https://medium.com/@rijuldahiya/integrating-ollama-with-goose-codename-a-comprehensive-guide-to-local-ai-deployment-across-server-573d98ef5820](https://medium.com/@rijuldahiya/integrating-ollama-with-goose-codename-a-comprehensive-guide-to-local-ai-deployment-across-server-573d98ef5820) 64 | -------------------------------------------------------------------------------- /docs/refact.md: -------------------------------------------------------------------------------- 1 | --- 2 | tags: 3 | - vscode 4 | - gui 5 | --- 6 | 7 | # Refact 8 | 9 | | Website | GitHub | License | 10 | | --- | --- | --- | 11 | | [refact.ai](https://refact.ai/) | [smallcloudai/refact](https://github.com/smallcloudai/refact) | BSD-3-Clause | 12 | 13 | **Refact.ai is an open-source AI coding assistant that you can use as a plugin in IDEs like VS Code and JetBrains. It's designed to help developers with a variety of tasks, making coding faster and improving code quality.** 14 | 15 | Refact.ai is a powerful and versatile AI coding assistant that is designed to be a seamless extension of your IDE. It's a comprehensive tool that can help you with a wide range of programming tasks, from generating code and automating tasks to refactoring and analyzing your codebase. The tool is built with a focus on being open source and customizable, allowing you to tailor it to your specific needs. 16 | 17 | ### Key Features 18 | 19 | * **IDE Integration:** Refact.ai is available as a plugin for popular IDEs like VS Code and JetBrains. This means it is deeply integrated into your development environment, allowing it to provide context-aware assistance and to be a seamless part of your workflow. 20 | * **Code Completion and Refactoring:** Refact.ai provides intelligent code completion that can help you to write code more efficiently. It can also help you to refactor your code, suggesting improvements and automating the process of making changes. 21 | * **In-IDE Chat:** Refact.ai includes an in-IDE chat interface that allows you to ask questions and get help with your code. You can ask it to explain a piece of code, suggest a refactoring, or even generate a new function from scratch. 22 | * **On-Premise Deployment:** For enhanced security, you can host Refact.ai on your own servers, ensuring that your code remains private. This makes it a great option for teams and organizations that have strict security requirements. 23 | 24 | Refact.ai is a powerful and flexible tool for any developer who wants to leverage the power of AI in their daily workflow. Its deep integration with popular IDEs, its intelligent code completion and refactoring capabilities, and its on-premise deployment option make it a valuable addition to any developer's toolkit. 25 | 26 | ## Installation 27 | 28 | ### VS Code 29 | 30 | 1. Open VS Code. 31 | 2. Go to the Extensions view (click the Extensions icon in the Activity Bar). 32 | 3. Search for "Refact.ai" and click "Install". 33 | 4. Reload VS Code. 34 | 35 | ### JetBrains 36 | 37 | 1. Open your JetBrains IDE. 38 | 2. Go to **Settings > Plugins**. 39 | 3. Search for "Refact.ai" and click "Install". 40 | 4. Restart your IDE. 41 | 42 | ### Self-Hosting (Docker) 43 | 44 | You can self-host Refact.ai using Docker. 45 | 46 | ```bash 47 | docker run -p 8008:8008 refact/refact 48 | ``` 49 | 50 | ## Quickstart 51 | 52 | 1. Install the Refact.ai extension for your IDE. 53 | 2. Open the Refact.ai chat window. 54 | 3. Select "Agent Mode". 55 | 4. Start a conversation with the agent by writing a prompt. 56 | 57 | ## Links 58 | 59 | * **Website:** https://refact.ai/ 60 | * **GitHub:** https://github.com/smallcloudai/refact 61 | * **Docs:** https://refact.ai/docs/ 62 | 63 | ## Tutorials 64 | 65 | * **Refact for VS Code – Installation Guide** — [https://docs.refact.ai/installation/vs-code/](https://docs.refact.ai/installation/vs-code/) 66 | * **Improved Coding Experience with Refact Plugin** (YouTube) — [https://www.youtube.com/watch?v=SsjOY4bJ4Yg](https://www.youtube.com/watch?v=SsjOY4bJ4Yg) 67 | * **How to Use Refact AI for Faster & Smarter Refactoring** — [https://medium.com/@shahneel2409/how-to-use-refact-ai-for-faster-and-smarter-code-refactoring-9ff999c2d733](https://medium.com/@shahneel2409/how-to-use-refact-ai-for-faster-and-smarter-code-refactoring-9ff999c2d733) 68 | * **NEW Fully FREE AI Software Engineer (Refact.ai)** (YouTube) — [https://www.youtube.com/watch?v=k4eSitgTKSc](https://www.youtube.com/watch?v=k4eSitgTKSc) 69 | -------------------------------------------------------------------------------- /docs/aider.md: -------------------------------------------------------------------------------- 1 | --- 2 | tags: 3 | - cli 4 | --- 5 | 6 | # Aider 7 | 8 | | Website | GitHub | License | 9 | | --- | --- | --- | 10 | | [aider.chat](https://aider.chat/) | [paul-gauthier/aider](https://github.com/paul-gauthier/aider) | Apache 2.0 | 11 | 12 | **Aider is an AI-powered pair programmer that runs in your terminal. It allows you to code with a large language model to edit code in your local git repository.** 13 | 14 | Aider is a command-line tool that brings the power of AI to your terminal, allowing you to work with a large language model to write and edit code. It's designed to be a seamless and intuitive experience, integrating directly with your local git repository. This allows you to easily track changes, and it feels like you're pair programming with a very capable assistant. 15 | 16 | ### Key Features 17 | 18 | * **Git Integration:** Aider's deep integration with git is one of its standout features. It automatically commits changes with descriptive messages, making it easy to see what the AI has done and to undo changes if necessary. This makes it a safe and transparent way to work with an AI assistant. 19 | * **Cross-Platform and IDE Agnostic:** Because it's a command-line tool, Aider can be used with any IDE or text editor. Whether you're using VS Code, IntelliJ, PyCharm, or Vim, you can use Aider without needing a specific plugin. This makes it a flexible tool that can fit into any developer's workflow. 20 | * **Multi-File Editing:** Aider is capable of editing multiple files at once to handle complex requests. This is a powerful feature that allows you to make changes across your entire codebase with a single prompt. 21 | * **Repository Map:** Aider creates a map of your entire git repository, which helps it to understand the context of your code and make more relevant and accurate changes. This is a key feature that sets it apart from other tools that only look at the current file. 22 | 23 | Aider is a powerful and flexible tool for any developer who wants to leverage the power of AI in their daily workflow. Its deep integration with git, its ability to edit multiple files, and its repository-aware context make it a valuable addition to any developer's toolkit. 24 | 25 | ## Installation 26 | 27 | ### pip 28 | 29 | ```bash 30 | python -m pip install aider-chat 31 | ``` 32 | 33 | ### pipx 34 | 35 | ```bash 36 | pipx install aider-chat 37 | ``` 38 | 39 | ### uv 40 | 41 | ```bash 42 | uv tool install --force --python python3.12 --with pip aider-chat@latest 43 | ``` 44 | 45 | ### Mac & Linux 46 | 47 | **curl** 48 | ```bash 49 | curl -LsSf https://aider.chat/install.sh | sh 50 | ``` 51 | 52 | **wget** 53 | ```bash 54 | wget -qO- https://aider.chat/install.sh | sh 55 | ``` 56 | 57 | ### Windows 58 | 59 | **PowerShell** 60 | ```powershell 61 | powershell -ExecutionPolicy ByPass -c "irm https://aider.chat/install.ps1 | iex" 62 | ``` 63 | 64 | ## Quickstart 65 | 66 | 1. Install aider using one of the methods above. 67 | 2. Set your OpenAI API key: 68 | ```bash 69 | export OPENAI_API_KEY=your-key-goes-here 70 | ``` 71 | 3. Run aider from within your git repository: 72 | ```bash 73 | aider 74 | ``` 75 | 76 | ## Links 77 | 78 | * **Website:** https://aider.chat/ 79 | * **GitHub:** https://github.com/Aider-AI/aider 80 | * **Discord:** https://discord.gg/Y7X7bhMQFV 81 | * **Blog:** https://aider.chat/blog/ 82 | 83 | ## Tutorials 84 | 85 | * **Official “Tutorial videos” collection** — [https://aider.chat/docs/usage/tutorials.html](https://aider.chat/docs/usage/tutorials.html) 86 | * **Better than GitHub Copilot? Aider AI Pair Programmer** (YouTube) — [https://www.youtube.com/watch?v=nYFrdypdsTk](https://www.youtube.com/watch?v=nYFrdypdsTk) 87 | * **Build the Ultimate AI Pair Programmer with Aider + DSL** (YouTube) — [https://www.youtube.com/watch?v=xV2CzBoJ2lc](https://www.youtube.com/watch?v=xV2CzBoJ2lc) 88 | * **Aider: Best AI Programming Assistant for the Terminal** (YouTube) — [https://www.youtube.com/watch?v=XzfDV_She-E](https://www.youtube.com/watch?v=XzfDV_She-E) -------------------------------------------------------------------------------- /docs/continue.md: -------------------------------------------------------------------------------- 1 | --- 2 | tags: 3 | - vscode 4 | - gui 5 | --- 6 | 7 | # Continue 8 | 9 | | Website | GitHub | License | 10 | | --- | --- | --- | 11 | | [continue.dev](https://www.continue.dev/) | [continuedev/continue](https://github.com/continuedev/continue) | Apache 2.0 | 12 | 13 | **Continue is an open-source AI code assistant that can be used as a plugin in IDEs like VS Code and JetBrains. It offers features like code completion, chat, and refactoring.** 14 | 15 | Continue is a powerful and flexible AI code assistant that is designed to be a seamless extension of your IDE. It's a versatile tool that can help you with a wide range of programming tasks, from generating code and automating tasks to refactoring and understanding your codebase. The tool is built with a focus on being open source and customizable, allowing you to tailor it to your specific needs. 16 | 17 | ### Key Features 18 | 19 | * **IDE Integration:** Continue is available as a plugin for popular IDEs like VS Code and JetBrains. This means it is deeply integrated into your development environment, allowing it to provide context-aware assistance and to be a seamless part of your workflow. 20 | * **AI-Powered Chat:** Continue includes an AI-powered chat interface that allows you to ask questions and get help with your code. You can ask it to explain a piece of code, suggest a refactoring, or even generate a new function from scratch. 21 | * **Code Completion and Refactoring:** Continue provides intelligent code completion that can help you to write code more efficiently. It can also help you to refactor your code, suggesting improvements and automating the process of making changes. 22 | * **Open Source and Customizable:** Continue is an open-source project, which means that you can inspect the code, contribute to the project, and even host it yourself. It's also highly customizable, allowing you to create your own custom commands and integrations. 23 | 24 | Continue is a powerful and flexible tool for any developer who wants to leverage the power of AI in their daily workflow. Its deep integration with popular IDEs, its AI-powered chat interface, and its open-source and customizable design make it a valuable addition to any developer's toolkit. 25 | 26 | ## Installation 27 | 28 | ### VS Code 29 | 30 | 1. Open VS Code. 31 | 2. Go to the Extensions view (click the Extensions icon in the Activity Bar). 32 | 3. Search for "Continue" and click "Install". 33 | 4. Reload VS Code. 34 | 35 | ### JetBrains 36 | 37 | 1. Open your JetBrains IDE. 38 | 2. Go to **Settings > Plugins**. 39 | 3. Search for "Continue" and click "Install". 40 | 4. Restart your IDE. 41 | 42 | ## Quickstart 43 | 44 | 1. After installing the extension, click the Continue icon in your IDE's sidebar. 45 | 2. Sign in to your Continue account to access all the features. 46 | 3. Start a conversation with Continue by typing your request in natural language. 47 | 48 | ## Links 49 | 50 | * **Website:** https://www.continue.dev/ 51 | * **GitHub:** https://github.com/continuedev/continue 52 | * **Docs:** https://docs.continue.dev/ 53 | * **Discord:** https://discord.gg/continue 54 | 55 | ## Tutorials 56 | 57 | * **Official docs – Introduction** — [https://docs.continue.dev/](https://docs.continue.dev/) 58 | * **Build a FREE AI Coding Assistant Locally in VS Code** (YouTube) — [https://www.youtube.com/watch?v=szNCJ2p5m_Y](https://www.youtube.com/watch?v=szNCJ2p5m_Y) 59 | * **Continue: The Leading Open-Source AI Code Assistant** (YouTube) — [https://www.youtube.com/watch?v=V3Yq6w9QaxI](https://www.youtube.com/watch?v=V3Yq6w9QaxI) 60 | * **Setting up a Remote AI Code Assistant: Ollama + Continue** — [https://medium.com/@texchi2/setting-up-a-remote-ai-code-assistant-ollama-continue-in-vs-code-ce94101c7dc6](https://medium.com/@texchi2/setting-up-a-remote-ai-code-assistant-ollama-continue-in-vs-code-ce94101c7dc6) 61 | * **Local AI Assistance with Continue & Ollama** — [https://www.pedroalonso.net/blog/local-ai-assitance-with-continue-ollama-vscode/](https://www.pedroalonso.net/blog/local-ai-assitance-with-continue-ollama-vscode/) 62 | -------------------------------------------------------------------------------- /docs/codex-cli.md: -------------------------------------------------------------------------------- 1 | --- 2 | tags: 3 | - cli 4 | --- 5 | 6 | # Codex CLI 7 | 8 | | Website | GitHub | License | 9 | | --- | --- | --- | 10 | | [openai.com/blog/openai-codex](https://openai.com/blog/openai-codex) | [openai/codex](https://github.com/openai/codex) | Apache 2.0 | 11 | 12 | **Codex CLI is a command-line interface that brings the power of OpenAI's Codex to your terminal. It allows you to interact with your codebase using natural language, making it a powerful tool for a variety of software development tasks.** 13 | 14 | Codex CLI is designed to be a versatile and intuitive tool for developers. It can be used in several modes, providing flexibility in how you interact with your code. The primary goal of Codex CLI is to accelerate development by allowing you to express your intent in plain English, which the tool then translates into code. 15 | 16 | ### Key Features 17 | 18 | * **Natural Language Interaction:** The core feature of Codex CLI is its ability to understand and respond to natural language prompts. You can ask it to perform tasks like "create a new function that takes a string as input and returns the reverse of that string" and it will generate the corresponding code. 19 | * **Multiple Interaction Modes:** 20 | * **Suggest Mode:** In this mode, Codex CLI will propose changes to your code, which you can then approve or reject. This gives you full control over the modifications being made. 21 | * **Auto Edit Mode:** This mode automatically applies file edits but will prompt you for confirmation before executing any shell commands. This is a good balance between automation and safety. 22 | * **Full Auto Mode:** In this mode, Codex CLI will run on its own, confined to a directory that you specify. This is useful for tasks that you are confident can be automated without supervision. 23 | * **Code Understanding:** Beyond just generating code, Codex CLI can also help you understand unfamiliar codebases. You can ask it to explain a specific function or file, and it will provide a natural language description of what the code does. 24 | 25 | Codex CLI is a powerful tool for any developer looking to leverage the power of AI to improve their workflow. Its ability to understand natural language and interact with your code in a variety of ways makes it a valuable addition to any developer's toolkit. 26 | 27 | ## Installation 28 | 29 | ### npm 30 | 31 | ```bash 32 | npm i -g @openai/codex 33 | ``` 34 | 35 | ### Homebrew 36 | 37 | ```bash 38 | brew install codex 39 | ``` 40 | 41 | ### Manual 42 | 43 | Download the appropriate binary from the [latest GitHub Release](https://github.com/openai/codex/releases/latest). 44 | 45 | ## Quickstart 46 | 47 | 1. Install `codex-cli` using one of the methods above. 48 | 2. Set your OpenAI API key: 49 | ```bash 50 | export OPENAI_API_KEY="your-api-key-here" 51 | ``` 52 | 3. Run interactively: 53 | ```bash 54 | codex 55 | ``` 56 | 4. Or, run with a prompt: 57 | ```bash 58 | codex "explain this codebase to me" 59 | ``` 60 | 61 | ## Links 62 | 63 | * **GitHub:** https://github.com/openai/codex 64 | * **Releases:** https://github.com/openai/codex/releases 65 | 66 | ## Tutorials 67 | 68 | * **OpenAI Codex CLI – Getting Started** — [https://help.openai.com/en/articles/11096431-openai-codex-cli-getting-started](https://help.openai.com/en/articles/11096431-openai-codex-cli-getting-started) 69 | * **OpenAI Codex CLI Tutorial** — [https://www.datacamp.com/tutorial/open-ai-codex-cli-tutorial](https://www.datacamp.com/tutorial/open-ai-codex-cli-tutorial) 70 | * **Meet Codex CLI** (YouTube) — [https://www.youtube.com/watch?v=FUq9qRwrDrI](https://www.youtube.com/watch?v=FUq9qRwrDrI) 71 | * **How to Install and Use OpenAI Codex CLI** (YouTube) — [https://www.youtube.com/watch?v=Zn8n2U8sTkw](https://www.youtube.com/watch?v=Zn8n2U8sTkw) 72 | * **How to Install and Use OpenAI Codex CLI (In 2 Minutes)** — [https://medium.com/ai-software-engineer/how-to-install-and-use-openai-codex-cli-in-2-minutes-29e9fdd0e8c5](https://medium.com/ai-software-engineer/how-to-install-and-use-openai-codex-cli-in-2-minutes-29e9fdd0e8c5) 73 | -------------------------------------------------------------------------------- /docs/github-copilot-chat.md: -------------------------------------------------------------------------------- 1 | --- 2 | tags: 3 | - gui 4 | - vscode 5 | --- 6 | 7 | # GitHub Copilot Chat 8 | 9 | | Website | GitHub | License | 10 | | --- | --- | --- | 11 | | [github.com/features/copilot](https://github.com/features/copilot) | [microsoft/vscode-copilot-chat](https://github.com/microsoft/vscode-copilot-chat) | MIT | 12 | 13 | **GitHub Copilot Chat is an AI-powered chat interface for Visual Studio Code that assists with various coding-related tasks.** 14 | 15 | The GitHub Copilot Chat extension for Visual Studio Code brings the power of GitHub Copilot directly into the editor, providing a chat-based interface for interacting with the AI assistant. While the extension itself is open-source under the MIT license, the underlying GitHub Copilot service that powers it is a proprietary, subscription-based product. This page focuses on the open-source VS Code extension. 16 | 17 | ### Key Features 18 | 19 | * **Deep Integration with GitHub:** GitHub Copilot Chat is deeply integrated with the GitHub ecosystem, which allows it to provide context-aware assistance. It can answer questions about specific repositories, commits, and pull requests, and it can even help you to write commit messages and release notes. 20 | * **Code Generation and Explanation:** GitHub Copilot Chat can be used to generate code snippets, write entire functions, and even create new applications from scratch. It can also be used to understand existing codebases, providing explanations of complex code in natural language. 21 | * **Debugging and Security Fixes:** The tool can help you to identify and fix bugs in your code, and it can also suggest remediations for security vulnerabilities. This makes it a valuable tool for improving the quality and security of your code. 22 | * **Availability in Multiple Environments:** GitHub Copilot Chat is available in a variety of environments, including your IDE, the GitHub website, and the GitHub Mobile app. This makes it a convenient and accessible tool that you can use wherever you are. 23 | 24 | GitHub Copilot Chat is a powerful and versatile tool for any developer who wants to leverage the power of AI in their daily workflow. Its deep integration with the GitHub ecosystem, its ability to generate and explain code, and its availability in multiple environments make it a valuable addition to any developer's toolkit. 25 | 26 | ## Installation 27 | 28 | ### VS Code 29 | 30 | 1. Open VS Code. 31 | 2. Go to the Extensions view (click the Extensions icon in the Activity Bar). 32 | 3. Search for "GitHub Copilot Chat" and click "Install". 33 | 4. You will be prompted to sign in with your GitHub account. 34 | 35 | ### Visual Studio 36 | 37 | 1. Ensure you have Visual Studio 2022 version 17.8 or later. 38 | 2. The GitHub Copilot extension is included in the installer. 39 | 3. Sign in to Visual Studio with the GitHub account that has an active Copilot subscription. 40 | 41 | ### JetBrains 42 | 43 | 1. In your JetBrains IDE, go to **Settings/Preferences > Plugins**. 44 | 2. Search for "GitHub Copilot" in the Marketplace and click "Install". 45 | 3. Restart your IDE. 46 | 4. From the **Tools** menu, select **GitHub Copilot > Login to GitHub**. 47 | 48 | ## Quickstart 49 | 50 | 1. After installing the extension, open the Chat view. 51 | * **VS Code:** Click the Chat icon in the Activity Bar or use `Ctrl+Alt+I`. 52 | * **Visual Studio:** Go to **View > GitHub Copilot Chat**. 53 | * **JetBrains:** Click the Copilot icon on the right side of the IDE. 54 | 2. Ask a question in natural language, for example: "what does this file do". 55 | 3. You can also select a block of code and ask a question about it. 56 | 57 | ## Links 58 | 59 | * **Website:** https://github.com/features/copilot 60 | * **GitHub:** https://github.com/microsoft/vscode-copilot-chat 61 | * **Documentation:** https://docs.github.com/en/copilot/github-copilot-chat/using-github-copilot-chat 62 | 63 | ## Tutorials 64 | 65 | * **Asking Copilot Chat Questions in Your IDE** — [https://docs.github.com/en/copilot/how-tos/chat/asking-github-copilot-questions-in-your-ide](https://docs.github.com/en/copilot/how-tos/chat/asking-github-copilot-questions-in-your-ide) 66 | * **Getting Started with Copilot Chat in VS Code** — [https://code.visualstudio.com/docs/copilot/chat/getting-started-chat](https://code.visualstudio.com/docs/copilot/chat/getting-started-chat) 67 | * **GitHub Copilot – Getting Started with Chat** (YouTube) — [https://www.youtube.com/watch?v=3surPGP7_4o](https://www.youtube.com/watch?v=3surPGP7_4o) 68 | * **Get Started with GitHub Copilot & Copilot Chat** (YouTube) — [https://www.youtube.com/watch?v=XJbVDsJPqC8](https://www.youtube.com/watch?v=XJbVDsJPqC8) 69 | * **Copilot Chat – Overview & Prompts** — [https://docs.github.com/en/copilot/how-tos/chat](https://docs.github.com/en/copilot/how-tos/chat) 70 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Creative Commons Legal Code 2 | 3 | CC0 1.0 Universal 4 | 5 | CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE 6 | LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN 7 | ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS 8 | INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES 9 | REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS 10 | PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM 11 | THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED 12 | HEREUNDER. 13 | 14 | Statement of Purpose 15 | 16 | The laws of most jurisdictions throughout the world automatically confer 17 | exclusive Copyright and Related Rights (defined below) upon the creator 18 | and subsequent owner(s) (each and all, an "owner") of an original work of 19 | authorship and/or a database (each, a "Work"). 20 | 21 | Certain owners wish to permanently relinquish those rights to a Work for 22 | the purpose of contributing to a commons of creative, cultural and 23 | scientific works ("Commons") that the public can reliably and without fear 24 | of later claims of infringement build upon, modify, incorporate in other 25 | works, reuse and redistribute as freely as possible in any form whatsoever 26 | and for any purposes, including without limitation commercial purposes. 27 | These owners may contribute to the Commons to promote the ideal of a free 28 | culture and the further production of creative, cultural and scientific 29 | works, or to gain reputation or greater distribution for their Work in 30 | part through the use and efforts of others. 31 | 32 | For these and/or other purposes and motivations, and without any 33 | expectation of additional consideration or compensation, the person 34 | associating CC0 with a Work (the "Affirmer"), to the extent that he or she 35 | is an owner of Copyright and Related Rights in the Work, voluntarily 36 | elects to apply CC0 to the Work and publicly distribute the Work under its 37 | terms, with knowledge of his or her Copyright and Related Rights in the 38 | Work and the meaning and intended legal effect of CC0 on those rights. 39 | 40 | 1. Copyright and Related Rights. A Work made available under CC0 may be 41 | protected by copyright and related or neighboring rights ("Copyright and 42 | Related Rights"). Copyright and Related Rights include, but are not 43 | limited to, the following: 44 | 45 | i. the right to reproduce, adapt, distribute, perform, display, 46 | communicate, and translate a Work; 47 | ii. moral rights retained by the original author(s) and/or performer(s); 48 | iii. publicity and privacy rights pertaining to a person's image or 49 | likeness depicted in a Work; 50 | iv. rights protecting against unfair competition in regards to a Work, 51 | subject to the limitations in paragraph 4(a), below; 52 | v. rights protecting the extraction, dissemination, use and reuse of data 53 | in a Work; 54 | vi. database rights (such as those arising under Directive 96/9/EC of the 55 | European Parliament and of the Council of 11 March 1996 on the legal 56 | protection of databases, and under any national implementation 57 | thereof, including any amended or successor version of such 58 | directive); and 59 | vii. other similar, equivalent or corresponding rights throughout the 60 | world based on applicable law or treaty, and any national 61 | implementations thereof. 62 | 63 | 2. Waiver. To the greatest extent permitted by, but not in contravention 64 | of, applicable law, Affirmer hereby overtly, fully, permanently, 65 | irrevocably and unconditionally waives, abandons, and surrenders all of 66 | Affirmer's Copyright and Related Rights and associated claims and causes 67 | of action, whether now known or unknown (including existing as well as 68 | future claims and causes of action), in the Work (i) in all territories 69 | worldwide, (ii) for the maximum duration provided by applicable law or 70 | treaty (including future time extensions), (iii) in any current or future 71 | medium and for any number of copies, and (iv) for any purpose whatsoever, 72 | including without limitation commercial, advertising or promotional 73 | purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each 74 | member of the public at large and to the detriment of Affirmer's heirs and 75 | successors, fully intending that such Waiver shall not be subject to 76 | revocation, rescission, cancellation, termination, or any other legal or 77 | equitable action to disrupt the quiet enjoyment of the Work by the public 78 | as contemplated by Affirmer's express Statement of Purpose. 79 | 80 | 3. Public License Fallback. Should any part of the Waiver for any reason 81 | be judged legally invalid or ineffective under applicable law, then the 82 | Waiver shall be preserved to the maximum extent permitted taking into 83 | account Affirmer's express Statement of Purpose. In addition, to the 84 | extent the Waiver is so judged Affirmer hereby grants to each affected 85 | person a royalty-free, non transferable, non sublicensable, non exclusive, 86 | irrevocable and unconditional license to exercise Affirmer's Copyright and 87 | Related Rights in the Work (i) in all territories worldwide, (ii) for the 88 | maximum duration provided by applicable law or treaty (including future 89 | time extensions), (iii) in any current or future medium and for any number 90 | of copies, and (iv) for any purpose whatsoever, including without 91 | limitation commercial, advertising or promotional purposes (the 92 | "License"). The License shall be deemed effective as of the date CC0 was 93 | applied by Affirmer to the Work. Should any part of the License for any 94 | reason be judged legally invalid or ineffective under applicable law, such 95 | partial invalidity or ineffectiveness shall not invalidate the remainder 96 | of the License, and in such case Affirmer hereby affirms that he or she 97 | will not (i) exercise any of his or her remaining Copyright and Related 98 | Rights in the Work or (ii) assert any associated claims and causes of 99 | action with respect to the Work, in either case contrary to Affirmer's 100 | express Statement of Purpose. 101 | 102 | 4. Limitations and Disclaimers. 103 | 104 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 105 | surrendered, licensed or otherwise affected by this document. 106 | b. Affirmer offers the Work as-is and makes no representations or 107 | warranties of any kind concerning the Work, express, implied, 108 | statutory or otherwise, including without limitation warranties of 109 | title, merchantability, fitness for a particular purpose, non 110 | infringement, or the absence of latent or other defects, accuracy, or 111 | the present or absence of errors, whether or not discoverable, all to 112 | the greatest extent permissible under applicable law. 113 | c. Affirmer disclaims responsibility for clearing rights of other persons 114 | that may apply to the Work or any use thereof, including without 115 | limitation any person's Copyright and Related Rights in the Work. 116 | Further, Affirmer disclaims responsibility for obtaining any necessary 117 | consents, permissions or other rights required for any use of the 118 | Work. 119 | d. Affirmer understands and acknowledges that Creative Commons is not a 120 | party to this document and has no duty or obligation with respect to 121 | this CC0 or use of the Work. 122 | --------------------------------------------------------------------------------