├── src
└── shelloracle
│ ├── __init__.py
│ ├── py.typed
│ ├── __main__.py
│ ├── shell
│ ├── shelloracle.fish
│ ├── shelloracle.bash
│ └── shelloracle.zsh
│ ├── cli
│ ├── config
│ │ ├── __init__.py
│ │ ├── edit.py
│ │ ├── init.py
│ │ └── show.py
│ ├── application.py
│ └── __init__.py
│ ├── tty_log_handler.py
│ ├── providers
│ ├── google.py
│ ├── openai.py
│ ├── deepseek.py
│ ├── openai_compat.py
│ ├── localai.py
│ ├── xai.py
│ ├── ollama.py
│ └── __init__.py
│ ├── config.py
│ ├── shelloracle.py
│ └── bootstrap.py
├── .github
├── FUNDING.yml
└── workflows
│ ├── lint.yml
│ ├── tests.yml
│ └── release.yml
├── tests
├── conftest.py
├── providers
│ ├── test_localai.py
│ ├── test_openai.py
│ ├── test_xai.py
│ ├── conftest.py
│ ├── test_deepseek.py
│ └── test_ollama.py
├── test_shelloracle.py
└── test_config.py
├── CITATION.cff
├── pyproject.toml
├── .gitignore
├── README.md
└── LICENSE
/src/shelloracle/__init__.py:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/src/shelloracle/py.typed:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | github: [djcopley]
2 |
--------------------------------------------------------------------------------
/src/shelloracle/__main__.py:
--------------------------------------------------------------------------------
1 | if __name__ == "__main__":
2 | from shelloracle.cli import main
3 |
4 | main()
5 |
--------------------------------------------------------------------------------
/tests/conftest.py:
--------------------------------------------------------------------------------
1 | import pytest
2 |
3 | from shelloracle.cli import Application
4 |
5 |
6 | @pytest.fixture
7 | def global_app():
8 | return Application()
9 |
--------------------------------------------------------------------------------
/src/shelloracle/shell/shelloracle.fish:
--------------------------------------------------------------------------------
1 | function __shelloracle__
2 | set -l output (shor)
3 | if test $status -ne 0
4 | return $status
5 | end
6 | commandline -r -- $output
7 | end
8 |
9 | bind \cf __shelloracle__
10 |
--------------------------------------------------------------------------------
/CITATION.cff:
--------------------------------------------------------------------------------
1 | cff-version: 1.2.0
2 | message: "If you reference this software, please cite it as below."
3 | authors:
4 | - family-names: "Copley"
5 | given-names: "Daniel"
6 | orcid: "https://orcid.org/0009-0003-9149-0518"
7 | title: "ShellOracle"
8 | url: "https://github.com/djcopley/ShellOracle"
--------------------------------------------------------------------------------
/src/shelloracle/cli/config/__init__.py:
--------------------------------------------------------------------------------
1 | import click
2 |
3 | from shelloracle.cli.config.edit import edit
4 | from shelloracle.cli.config.init import init
5 | from shelloracle.cli.config.show import show
6 |
7 |
8 | @click.group()
9 | def config(): ...
10 |
11 |
12 | config.add_command(edit)
13 | config.add_command(init)
14 | config.add_command(show)
15 |
--------------------------------------------------------------------------------
/src/shelloracle/cli/config/edit.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | from typing import TYPE_CHECKING
4 |
5 | import click
6 |
7 | if TYPE_CHECKING:
8 | from shelloracle.cli.application import Application
9 |
10 |
11 | @click.command()
12 | @click.pass_obj
13 | def edit(app: Application):
14 | """Edit shelloracle configuration."""
15 | click.edit(filename=app.config_path)
16 |
--------------------------------------------------------------------------------
/src/shelloracle/cli/config/init.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | from typing import TYPE_CHECKING
4 |
5 | import click
6 |
7 | if TYPE_CHECKING:
8 | from shelloracle.cli import Application
9 |
10 |
11 | @click.command()
12 | @click.pass_obj
13 | def init(app: Application):
14 | """Install shelloracle keybindings."""
15 | # nest this import in a function to avoid expensive module loads
16 | from shelloracle.bootstrap import bootstrap_shelloracle
17 |
18 | bootstrap_shelloracle(app.config_path)
19 |
--------------------------------------------------------------------------------
/src/shelloracle/cli/application.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | import typing
4 | from pathlib import Path
5 |
6 | if typing.TYPE_CHECKING:
7 | from shelloracle.config import Configuration
8 |
9 | shelloracle_home = Path.home() / ".shelloracle"
10 | shelloracle_home.mkdir(exist_ok=True)
11 |
12 |
13 | class Application:
14 | configuration: Configuration
15 |
16 | def __init__(self):
17 | self.config_path = shelloracle_home / "config.toml"
18 | self.log_path = shelloracle_home / "shelloracle.log"
19 |
--------------------------------------------------------------------------------
/src/shelloracle/cli/config/show.py:
--------------------------------------------------------------------------------
1 | import click
2 | import pygments
3 | from prompt_toolkit import print_formatted_text
4 | from prompt_toolkit.formatted_text import PygmentsTokens
5 | from pygments.lexers import TOMLLexer
6 |
7 | from shelloracle.cli.application import Application
8 |
9 |
10 | @click.command()
11 | @click.pass_obj
12 | def show(app: Application):
13 | """Display shelloracle configuration."""
14 | with app.config_path.open("r") as f:
15 | tokens = list(pygments.lex(f.read(), lexer=TOMLLexer()))
16 | print_formatted_text(PygmentsTokens(tokens))
17 |
--------------------------------------------------------------------------------
/src/shelloracle/shell/shelloracle.bash:
--------------------------------------------------------------------------------
1 | __shelloracle__() {
2 | local output
3 | output=$(shor) || return
4 | READLINE_LINE=${output#*$'\t'}
5 | if [[ -z "$READLINE_POINT" ]]; then
6 | echo "$READLINE_LINE"
7 | else
8 | READLINE_POINT=0x7fffffff
9 | fi
10 | }
11 |
12 | if (( BASH_VERSINFO[0] < 4 )); then
13 | bind -m emacs-standard '"\C-f": "\C-e \C-u\C-y\ey\C-u"$(__shelloracle__)"\e\C-e\er"'
14 | bind -m vi-command '"\C-f": "\C-z\C-r\C-z"'
15 | bind -m vi-insert '"\C-f": "\C-z\C-r\C-z"'
16 | else
17 | bind -m emacs-standard -x '"\C-f": __shelloracle__'
18 | bind -m vi-command -x '"\C-f": __shelloracle__'
19 | bind -m vi-insert -x '"\C-f": __shelloracle__'
20 | fi
21 |
--------------------------------------------------------------------------------
/.github/workflows/lint.yml:
--------------------------------------------------------------------------------
1 | name: Lint
2 | on:
3 | push:
4 | pull_request:
5 | permissions:
6 | contents: read
7 |
8 | jobs:
9 | ruff:
10 | runs-on: ubuntu-latest
11 | steps:
12 | - uses: actions/checkout@v4
13 | - uses: actions/setup-python@v5
14 | with:
15 | python-version: "3.x"
16 | - uses: pypa/hatch@install
17 | - name: Run ruff linter and formatter
18 | run: hatch fmt --check
19 | mypy:
20 | runs-on: ubuntu-latest
21 | steps:
22 | - uses: actions/checkout@v4
23 | with:
24 | fetch-depth: 0
25 | - uses: actions/setup-python@v5
26 | with:
27 | python-version: "3.x"
28 | - uses: pypa/hatch@install
29 | - name: Run mypy
30 | run: hatch run types:check
31 |
--------------------------------------------------------------------------------
/src/shelloracle/tty_log_handler.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | import logging
4 |
5 | from prompt_toolkit import print_formatted_text
6 | from prompt_toolkit.application import create_app_session_from_tty
7 | from prompt_toolkit.formatted_text import FormattedText
8 |
9 |
10 | class TtyLogHandler(logging.Handler):
11 | def emit(self, record: logging.LogRecord):
12 | if record.levelno >= logging.ERROR:
13 | color = "ansired"
14 | elif record.levelno == logging.WARNING:
15 | color = "ansiyellow"
16 | else:
17 | color = "ansywhite"
18 | log_entry = self.format(record)
19 | formatted_log_entry = FormattedText([(color, f"\n{log_entry}")])
20 | with create_app_session_from_tty():
21 | print_formatted_text(formatted_log_entry)
22 |
--------------------------------------------------------------------------------
/.github/workflows/tests.yml:
--------------------------------------------------------------------------------
1 | name: Tests
2 | on:
3 | push:
4 | pull_request:
5 | concurrency:
6 | group: test-${{ github.ref }}
7 | cancel-in-progress: true
8 | permissions:
9 | contents: read
10 |
11 | jobs:
12 | test:
13 | name: Test with ${{ matrix.py }}
14 | runs-on: ubuntu-latest
15 | strategy:
16 | fail-fast: false
17 | matrix:
18 | py:
19 | - "3.13"
20 | - "3.12"
21 | - "3.11"
22 | - "3.10"
23 | - "3.9"
24 | steps:
25 | - uses: pypa/hatch@install
26 | - uses: actions/checkout@v3
27 | with:
28 | fetch-depth: 0
29 | - name: Setup python for test ${{ matrix.py }}
30 | uses: actions/setup-python@v4
31 | with:
32 | python-version: ${{ matrix.py }}
33 | - name: Run test suite
34 | run: hatch test -py=${{ matrix.py }}
35 |
--------------------------------------------------------------------------------
/src/shelloracle/shell/shelloracle.zsh:
--------------------------------------------------------------------------------
1 | # Define the function shelloracle-widget
2 | shelloracle-widget() {
3 | # Set options and suppress any error messages
4 | setopt localoptions noglobsubst noposixbuiltins pipefail no_aliases 2> /dev/null
5 |
6 | # Run the shelloracle python module and store the result in the "selected" array
7 | local selected=( $(SHOR_DEFAULT_PROMPT=${LBUFFER} shor) )
8 |
9 | # Get the return status of the last executed command
10 | local ret=$?
11 |
12 | # Reset the prompt
13 | zle reset-prompt
14 |
15 | # Set the BUFFER variable to the selected result
16 | BUFFER=$selected
17 |
18 | # Set the CURSOR position at the end of BUFFER
19 | CURSOR=$#BUFFER
20 |
21 | # Return the status
22 | return $ret
23 | }
24 |
25 | # Register the function as a ZLE widget
26 | zle -N shelloracle-widget
27 |
28 | # Install the ZLE widget as a keyboard shortcut Ctrl+F
29 | bindkey '^F' shelloracle-widget
--------------------------------------------------------------------------------
/tests/providers/test_localai.py:
--------------------------------------------------------------------------------
1 | import pytest
2 |
3 | from shelloracle.providers.localai import LocalAI
4 |
5 |
6 | class TestOpenAI:
7 | @pytest.fixture
8 | def localai_config(self):
9 | return {
10 | "shelloracle": {"provider": "LocalAI"},
11 | "provider": {"LocalAI": {"host": "localhost", "port": 8080, "model": "mistral-openorca"}},
12 | }
13 |
14 | @pytest.fixture
15 | def localai_instance(self, localai_config):
16 | return LocalAI(localai_config)
17 |
18 | def test_name(self):
19 | assert LocalAI.name == "LocalAI"
20 |
21 | def test_model(self, localai_instance):
22 | assert localai_instance.model == "mistral-openorca"
23 |
24 | @pytest.mark.asyncio
25 | async def test_generate(self, mock_asyncopenai, localai_instance):
26 | result = ""
27 | async for response in localai_instance.generate(""):
28 | result += response
29 | assert result == "head -c 100 /dev/urandom | hexdump -C"
30 |
--------------------------------------------------------------------------------
/.github/workflows/release.yml:
--------------------------------------------------------------------------------
1 | name: Release
2 | on:
3 | release:
4 | types: [ published ]
5 | permissions:
6 | contents: read
7 |
8 | jobs:
9 | release-build:
10 | runs-on: ubuntu-latest
11 | steps:
12 | - uses: actions/checkout@v4
13 | - uses: actions/setup-python@v5
14 | with:
15 | python-version: "3.x"
16 | - name: Build release distributions
17 | run: |
18 | pip install build
19 | python -m build
20 | - name: upload windows dists
21 | uses: actions/upload-artifact@v4
22 | with:
23 | name: release-dists
24 | path: dist/
25 | pypi-publish:
26 | runs-on: ubuntu-latest
27 | needs:
28 | - release-build
29 | environment: release
30 | permissions:
31 | id-token: write
32 | steps:
33 | - name: Retrieve release distributions
34 | uses: actions/download-artifact@v4
35 | with:
36 | name: release-dists
37 | path: dist/
38 | - name: Publish release distributions to PyPI
39 | uses: pypa/gh-action-pypi-publish@release/v1
40 |
--------------------------------------------------------------------------------
/tests/providers/test_openai.py:
--------------------------------------------------------------------------------
1 | import pytest
2 |
3 | from shelloracle.config import Configuration
4 | from shelloracle.providers.openai import OpenAI
5 |
6 |
7 | class TestOpenAI:
8 | @pytest.fixture
9 | def openai_config(self):
10 | config = {
11 | "shelloracle": {"provider": "OpenAI"},
12 | "provider": {
13 | "OpenAI": {"api_key": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "model": "gpt-3.5-turbo"}
14 | },
15 | }
16 | return Configuration(config)
17 |
18 | @pytest.fixture
19 | def openai_instance(self, openai_config):
20 | return OpenAI(openai_config)
21 |
22 | def test_name(self):
23 | assert OpenAI.name == "OpenAI"
24 |
25 | def test_api_key(self, openai_instance):
26 | assert openai_instance.api_key == "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
27 |
28 | def test_model(self, openai_instance):
29 | assert openai_instance.model == "gpt-3.5-turbo"
30 |
31 | @pytest.mark.asyncio
32 | async def test_generate(self, mock_asyncopenai, openai_instance):
33 | result = ""
34 | async for response in openai_instance.generate(""):
35 | result += response
36 | assert result == "head -c 100 /dev/urandom | hexdump -C"
37 |
--------------------------------------------------------------------------------
/src/shelloracle/providers/google.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | from typing import TYPE_CHECKING
4 |
5 | import google.generativeai as genai
6 |
7 | from shelloracle.providers import Provider, ProviderError, Setting, system_prompt
8 |
9 | if TYPE_CHECKING:
10 | from collections.abc import AsyncIterator
11 |
12 |
13 | class Google(Provider):
14 | name = "Google"
15 |
16 | api_key = Setting(default="")
17 | model = Setting(default="gemini-2.0-flash") # Assuming a default model name
18 |
19 | def __init__(self, *args, **kwargs) -> None:
20 | super().__init__(*args, **kwargs)
21 | if not self.api_key:
22 | msg = "No API key provided"
23 | raise ProviderError(msg)
24 | genai.configure(api_key=self.api_key)
25 | self.model_instance = genai.GenerativeModel(self.model, system_instruction=system_prompt)
26 |
27 | async def generate(self, prompt: str) -> AsyncIterator[str]:
28 | try:
29 | response = await self.model_instance.generate_content_async(
30 | [prompt],
31 | stream=True,
32 | )
33 |
34 | async for chunk in response:
35 | yield chunk.text
36 | except Exception as e:
37 | msg = f"Something went wrong while querying Google Gemini: {e}"
38 | raise ProviderError(msg) from e
39 |
--------------------------------------------------------------------------------
/tests/providers/test_xai.py:
--------------------------------------------------------------------------------
1 | import pytest
2 |
3 | from shelloracle.config import Configuration
4 | from shelloracle.providers.xai import XAI
5 |
6 |
7 | class TestOpenAI:
8 | @pytest.fixture
9 | def xai_config(self):
10 | config = {
11 | "shelloracle": {"provider": "XAI"},
12 | "provider": {
13 | "XAI": {
14 | "api_key": "xai-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
15 | "model": "grok-beta",
16 | }
17 | },
18 | }
19 | return Configuration(config)
20 |
21 | @pytest.fixture
22 | def xai_instance(self, xai_config):
23 | return XAI(xai_config)
24 |
25 | def test_name(self):
26 | assert XAI.name == "XAI"
27 |
28 | def test_api_key(self, xai_instance):
29 | assert (
30 | xai_instance.api_key
31 | == "xai-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
32 | )
33 |
34 | def test_model(self, xai_instance):
35 | assert xai_instance.model == "grok-beta"
36 |
37 | @pytest.mark.asyncio
38 | async def test_generate(self, mock_asyncopenai, xai_instance):
39 | result = ""
40 | async for response in xai_instance.generate(""):
41 | result += response
42 | assert result == "head -c 100 /dev/urandom | hexdump -C"
43 |
--------------------------------------------------------------------------------
/src/shelloracle/providers/openai.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | from typing import TYPE_CHECKING
4 |
5 | from openai import APIError, AsyncOpenAI
6 |
7 | from shelloracle.providers import Provider, ProviderError, Setting, system_prompt
8 |
9 | if TYPE_CHECKING:
10 | from collections.abc import AsyncIterator
11 |
12 |
13 | class OpenAI(Provider):
14 | name = "OpenAI"
15 |
16 | api_key = Setting(default="")
17 | model = Setting(default="gpt-3.5-turbo")
18 |
19 | def __init__(self, *args, **kwargs) -> None:
20 | super().__init__(*args, **kwargs)
21 | if not self.api_key:
22 | msg = "No API key provided"
23 | raise ProviderError(msg)
24 | self.client = AsyncOpenAI(api_key=self.api_key)
25 |
26 | async def generate(self, prompt: str) -> AsyncIterator[str]:
27 | try:
28 | stream = await self.client.chat.completions.create(
29 | model=self.model,
30 | messages=[{"role": "system", "content": system_prompt}, {"role": "user", "content": prompt}],
31 | stream=True,
32 | )
33 | async for chunk in stream:
34 | if chunk.choices[0].delta.content is not None:
35 | yield chunk.choices[0].delta.content
36 | except APIError as e:
37 | msg = f"Something went wrong while querying OpenAI: {e}"
38 | raise ProviderError(msg) from e
39 |
--------------------------------------------------------------------------------
/tests/providers/conftest.py:
--------------------------------------------------------------------------------
1 | from unittest.mock import MagicMock
2 |
3 | import pytest
4 |
5 |
6 | def split_with_delimiter(string, delim):
7 | result = []
8 | last_split = 0
9 | for index, character in enumerate(string):
10 | if character == delim:
11 | result.append(string[last_split : index + 1])
12 | last_split = index + 1
13 | if last_split != len(string):
14 | result.append(string[last_split:])
15 | return result
16 |
17 |
18 | @pytest.fixture
19 | def mock_asyncopenai(monkeypatch):
20 | class AsyncChatCompletionIterator:
21 | def __init__(self, answer: str):
22 | self.answer_index = 0
23 | self.answer_deltas = split_with_delimiter(answer, " ")
24 |
25 | def __aiter__(self):
26 | return self
27 |
28 | async def __anext__(self):
29 | if self.answer_index >= len(self.answer_deltas):
30 | raise StopAsyncIteration
31 | answer_chunk = self.answer_deltas[self.answer_index]
32 | self.answer_index += 1
33 | choice = MagicMock()
34 | choice.delta.content = answer_chunk
35 | chunk = MagicMock()
36 | chunk.choices = [choice]
37 | return chunk
38 |
39 | async def mock_acreate(*args, **kwargs):
40 | return AsyncChatCompletionIterator("head -c 100 /dev/urandom | hexdump -C")
41 |
42 | monkeypatch.setattr("openai.resources.chat.AsyncCompletions.create", mock_acreate)
43 |
--------------------------------------------------------------------------------
/tests/providers/test_deepseek.py:
--------------------------------------------------------------------------------
1 | import pytest
2 |
3 | from shelloracle.config import Configuration
4 | from shelloracle.providers.deepseek import Deepseek
5 |
6 |
7 | class TestOpenAI:
8 | @pytest.fixture
9 | def deepseek_config(self):
10 | config = {
11 | "shelloracle": {"provider": "Deepseek"},
12 | "provider": {
13 | "Deepseek": {
14 | "api_key": "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
15 | "model": "grok-beta",
16 | }
17 | },
18 | }
19 | return Configuration(config)
20 |
21 | @pytest.fixture
22 | def deepseek_instance(self, deepseek_config):
23 | return Deepseek(deepseek_config)
24 |
25 | def test_name(self):
26 | assert Deepseek.name == "Deepseek"
27 |
28 | def test_api_key(self, deepseek_instance):
29 | assert (
30 | deepseek_instance.api_key
31 | == "sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
32 | )
33 |
34 | def test_model(self, deepseek_instance):
35 | assert deepseek_instance.model == "grok-beta"
36 |
37 | @pytest.mark.asyncio
38 | async def test_generate(self, mock_asyncopenai, deepseek_instance):
39 | result = ""
40 | async for response in deepseek_instance.generate(""):
41 | result += response
42 | assert result == "head -c 100 /dev/urandom | hexdump -C"
43 |
--------------------------------------------------------------------------------
/src/shelloracle/providers/deepseek.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | from typing import TYPE_CHECKING
4 |
5 | from openai import APIError, AsyncOpenAI
6 |
7 | from shelloracle.providers import Provider, ProviderError, Setting, system_prompt
8 |
9 | if TYPE_CHECKING:
10 | from collections.abc import AsyncIterator
11 |
12 |
13 | class Deepseek(Provider):
14 | name = "Deepseek"
15 |
16 | api_key = Setting(default="")
17 | model = Setting(default="deepseek-chat")
18 |
19 | def __init__(self, *args, **kwargs) -> None:
20 | super().__init__(*args, **kwargs)
21 | if not self.api_key:
22 | msg = "No API key provided"
23 | raise ProviderError(msg)
24 | self.client = AsyncOpenAI(base_url="https://api.deepseek.com/v1", api_key=self.api_key)
25 |
26 | async def generate(self, prompt: str) -> AsyncIterator[str]:
27 | try:
28 | stream = await self.client.chat.completions.create(
29 | model=self.model,
30 | messages=[
31 | {"role": "system", "content": system_prompt},
32 | {"role": "user", "content": prompt},
33 | ],
34 | stream=True,
35 | )
36 | async for chunk in stream:
37 | if chunk.choices[0].delta.content is not None:
38 | yield chunk.choices[0].delta.content
39 | except APIError as e:
40 | msg = f"Something went wrong while querying Deepseek: {e}"
41 | raise ProviderError(msg) from e
42 |
--------------------------------------------------------------------------------
/src/shelloracle/providers/openai_compat.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | from typing import TYPE_CHECKING
4 |
5 | from openai import APIError, AsyncOpenAI
6 |
7 | from shelloracle.providers import Provider, ProviderError, Setting, system_prompt
8 |
9 | if TYPE_CHECKING:
10 | from collections.abc import AsyncIterator
11 |
12 |
13 | class OpenAICompat(Provider):
14 | name = "OpenAICompat"
15 |
16 | base_url = Setting(default="")
17 | api_key = Setting(default="")
18 | model = Setting(default="")
19 |
20 | def __init__(self, *args, **kwargs) -> None:
21 | super().__init__(*args, **kwargs)
22 | if not self.api_key:
23 | msg = "No API key provided. Use a dummy placeholder if no key is required"
24 | raise ProviderError(msg)
25 | self.client = AsyncOpenAI(api_key=self.api_key, base_url=self.base_url)
26 |
27 | async def generate(self, prompt: str) -> AsyncIterator[str]:
28 | try:
29 | stream = await self.client.chat.completions.create(
30 | model=self.model,
31 | messages=[{"role": "system", "content": system_prompt}, {"role": "user", "content": prompt}],
32 | stream=True,
33 | )
34 | async for chunk in stream:
35 | if chunk.choices[0].delta.content is not None:
36 | yield chunk.choices[0].delta.content
37 | except APIError as e:
38 | msg = f"Something went wrong while querying OpenAICompat: {e}"
39 | raise ProviderError(msg) from e
40 |
--------------------------------------------------------------------------------
/src/shelloracle/providers/localai.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | from typing import TYPE_CHECKING
4 |
5 | from openai import APIError, AsyncOpenAI
6 |
7 | from shelloracle.providers import Provider, ProviderError, Setting, system_prompt
8 |
9 | if TYPE_CHECKING:
10 | from collections.abc import AsyncIterator
11 |
12 |
13 | class LocalAI(Provider):
14 | name = "LocalAI"
15 |
16 | host = Setting(default="localhost")
17 | port = Setting(default=8080)
18 | model = Setting(default="mistral-openorca")
19 |
20 | @property
21 | def endpoint(self) -> str:
22 | return f"http://{self.host}:{self.port}"
23 |
24 | def __init__(self, *args, **kwargs) -> None:
25 | super().__init__(*args, **kwargs)
26 | # Use a placeholder API key so the client will work
27 | self.client = AsyncOpenAI(api_key="sk-xxx", base_url=self.endpoint)
28 |
29 | async def generate(self, prompt: str) -> AsyncIterator[str]:
30 | try:
31 | stream = await self.client.chat.completions.create(
32 | model=self.model,
33 | messages=[{"role": "system", "content": system_prompt}, {"role": "user", "content": prompt}],
34 | stream=True,
35 | )
36 | async for chunk in stream:
37 | if chunk.choices[0].delta.content is not None:
38 | yield chunk.choices[0].delta.content
39 | except APIError as e:
40 | msg = f"Something went wrong while querying LocalAI: {e}"
41 | raise ProviderError(msg) from e
42 |
--------------------------------------------------------------------------------
/src/shelloracle/providers/xai.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | from typing import TYPE_CHECKING
4 |
5 | from openai import APIError, AsyncOpenAI
6 |
7 | from shelloracle.providers import Provider, ProviderError, Setting, system_prompt
8 |
9 | if TYPE_CHECKING:
10 | from collections.abc import AsyncIterator
11 |
12 |
13 | class XAI(Provider):
14 | name = "XAI"
15 |
16 | api_key = Setting(default="")
17 | model = Setting(default="grok-beta")
18 |
19 | def __init__(self, *args, **kwargs) -> None:
20 | super().__init__(*args, **kwargs)
21 | if not self.api_key:
22 | msg = "No API key provided"
23 | raise ProviderError(msg)
24 | self.client = AsyncOpenAI(
25 | api_key=self.api_key,
26 | base_url="https://api.x.ai/v1",
27 | )
28 |
29 | async def generate(self, prompt: str) -> AsyncIterator[str]:
30 | try:
31 | stream = await self.client.chat.completions.create(
32 | model=self.model,
33 | messages=[
34 | {"role": "system", "content": system_prompt},
35 | {"role": "user", "content": prompt},
36 | ],
37 | stream=True,
38 | )
39 | async for chunk in stream:
40 | if chunk.choices[0].delta.content is not None:
41 | yield chunk.choices[0].delta.content
42 | except APIError as e:
43 | msg = f"Something went wrong while querying XAI: {e}"
44 | raise ProviderError(msg) from e
45 |
--------------------------------------------------------------------------------
/tests/test_shelloracle.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | import os
4 | import sys
5 | from unittest.mock import MagicMock, call
6 |
7 | import pytest
8 | from yaspin.spinners import Spinners
9 |
10 | from shelloracle.shelloracle import get_query_from_pipe, spinner
11 |
12 |
13 | @pytest.fixture
14 | def mock_yaspin(monkeypatch):
15 | mock = MagicMock()
16 | monkeypatch.setattr("shelloracle.shelloracle.yaspin", mock)
17 | return mock
18 |
19 |
20 | @pytest.mark.parametrize(("spinner_style", "expected"), [(None, call()), ("earth", call(Spinners.earth))])
21 | def test_spinner(spinner_style, expected, mock_yaspin):
22 | spinner(spinner_style)
23 | assert mock_yaspin.call_args == expected
24 |
25 |
26 | def test_spinner_fail(mock_yaspin):
27 | with pytest.raises(AttributeError):
28 | spinner("not a spinner style")
29 |
30 |
31 | @pytest.mark.parametrize(
32 | ("isatty", "readlines", "expected"), [(True, None, None), (False, [], None), (False, ["what is up"], "what is up")]
33 | )
34 | def test_get_query_from_pipe(isatty, readlines, expected, monkeypatch):
35 | monkeypatch.setattr(os, "isatty", lambda _: isatty)
36 | monkeypatch.setattr(sys.stdin, "readlines", lambda: readlines)
37 | assert get_query_from_pipe() == expected
38 |
39 |
40 | def test_get_query_from_pipe_fail(monkeypatch):
41 | monkeypatch.setattr(os, "isatty", lambda _: False)
42 | monkeypatch.setattr(sys.stdin, "readlines", lambda: ["what is up", "what is down"])
43 | with pytest.raises(ValueError, match="Multi-line input is not supported"):
44 | get_query_from_pipe()
45 |
--------------------------------------------------------------------------------
/tests/providers/test_ollama.py:
--------------------------------------------------------------------------------
1 | import pytest
2 | from pytest_httpx import IteratorStream
3 |
4 | from shelloracle.config import Configuration
5 | from shelloracle.providers.ollama import Ollama
6 |
7 |
8 | class TestOllama:
9 | @pytest.fixture
10 | def ollama_config(self):
11 | config = {
12 | "shelloracle": {"provider": "Ollama"},
13 | "provider": {"Ollama": {"host": "localhost", "port": 11434, "model": "dolphin-mistral"}},
14 | }
15 | return Configuration(config)
16 |
17 | @pytest.fixture
18 | def ollama_instance(self, ollama_config):
19 | return Ollama(ollama_config)
20 |
21 | def test_name(self):
22 | assert Ollama.name == "Ollama"
23 |
24 | def test_host(self, ollama_instance):
25 | assert ollama_instance.host == "localhost"
26 |
27 | def test_port(self, ollama_instance):
28 | assert ollama_instance.port == 11434
29 |
30 | def test_model(self, ollama_instance):
31 | assert ollama_instance.model == "dolphin-mistral"
32 |
33 | def test_endpoint(self, ollama_instance):
34 | assert ollama_instance.endpoint == "http://localhost:11434/api/generate"
35 |
36 | @pytest.mark.asyncio
37 | async def test_generate(self, ollama_instance, httpx_mock):
38 | responses = [
39 | b'{"response": "cat"}\n',
40 | b'{"response": " test"}\n',
41 | b'{"response": "."}\n',
42 | b'{"response": "py"}\n',
43 | b'{"response": ""}\n',
44 | ]
45 | httpx_mock.add_response(stream=IteratorStream(responses))
46 | result = ""
47 | async for response in ollama_instance.generate(""):
48 | result += response
49 | assert result == "cat test.py"
50 |
--------------------------------------------------------------------------------
/src/shelloracle/config.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | import logging
4 | import sys
5 | from collections.abc import Iterator, Mapping
6 | from typing import TYPE_CHECKING, Any
7 |
8 | from yaspin.spinners import SPINNERS_DATA
9 |
10 | if TYPE_CHECKING:
11 | from pathlib import Path
12 |
13 |
14 | if sys.version_info < (3, 11):
15 | import tomli as tomllib
16 | else:
17 | import tomllib
18 |
19 | logger = logging.getLogger(__name__)
20 |
21 |
22 | class Configuration(Mapping):
23 | def __init__(self, config: dict[str, Any]) -> None:
24 | """ShellOracle application configuration
25 |
26 | :param config: configuration dict
27 | :raises FileNotFoundError: if the configuration file does not exist
28 | """
29 | self._config = config
30 |
31 | def __getitem__(self, key: str) -> Any:
32 | return self._config[key]
33 |
34 | def __len__(self) -> int:
35 | return len(self._config)
36 |
37 | def __iter__(self) -> Iterator[Any]:
38 | return iter(self._config)
39 |
40 | def __str__(self):
41 | return f"Configuration({self._config})"
42 |
43 | def __repr__(self) -> str:
44 | return str(self)
45 |
46 | @property
47 | def raw_config(self) -> dict[str, Any]:
48 | return self._config
49 |
50 | @property
51 | def provider(self) -> str:
52 | return self["shelloracle"]["provider"]
53 |
54 | @property
55 | def spinner_style(self) -> str | None:
56 | style = self["shelloracle"].get("spinner_style", None)
57 | if not style:
58 | return None
59 | if style not in SPINNERS_DATA:
60 | logger.warning("invalid spinner style: %s", style)
61 | return None
62 | return style
63 |
64 | @classmethod
65 | def from_file(cls, filepath: Path):
66 | with filepath.open("rb") as config_file:
67 | config = tomllib.load(config_file)
68 | return cls(config)
69 |
--------------------------------------------------------------------------------
/tests/test_config.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | import pytest
4 | import tomli_w
5 |
6 | from shelloracle.config import Configuration
7 |
8 |
9 | class TestConfiguration:
10 | @pytest.fixture
11 | def default_config(self):
12 | return Configuration(
13 | {
14 | "shelloracle": {"provider": "Ollama", "spinner_style": "earth"},
15 | "provider": {"Ollama": {"host": "localhost", "port": 11434, "model": "dolphin-mistral"}},
16 | }
17 | )
18 |
19 | def test_from_file(self, default_config, tmp_path):
20 | config_path = tmp_path / "config.toml"
21 | with config_path.open("wb") as f:
22 | tomli_w.dump(default_config.raw_config, f)
23 | assert Configuration.from_file(config_path) == default_config
24 |
25 | def test_getitem(self, default_config):
26 | for key in default_config:
27 | assert default_config[key] == default_config.raw_config[key]
28 |
29 | def test_len(self, default_config):
30 | assert len(default_config) == len(default_config.raw_config)
31 |
32 | def test_iter(self, default_config):
33 | assert list(iter(default_config)) == list(iter(default_config.raw_config))
34 |
35 | def test_provider(self, default_config):
36 | assert default_config.provider == "Ollama"
37 |
38 | def test_spinner_style(self, default_config):
39 | assert default_config.spinner_style == "earth"
40 |
41 | def test_no_spinner_style(self, caplog):
42 | config = Configuration(
43 | {
44 | "shelloracle": {"provider": "Ollama"},
45 | "provider": {"Ollama": {"host": "localhost", "port": 11434, "model": "dolphin-mistral"}},
46 | }
47 | )
48 | assert config.spinner_style is None
49 | assert "invalid spinner style" not in caplog.text
50 |
51 | def test_invalid_spinner_style(self, caplog):
52 | config = Configuration(
53 | {
54 | "shelloracle": {"provider": "Ollama", "spinner_style": "invalid"},
55 | "provider": {"Ollama": {"host": "localhost", "port": 11434, "model": "dolphin-mistral"}},
56 | }
57 | )
58 | assert config.spinner_style is None
59 | assert "invalid spinner style" in caplog.text
60 |
--------------------------------------------------------------------------------
/src/shelloracle/cli/__init__.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | import asyncio
4 | import logging
5 | import os
6 | import sys
7 | from typing import TYPE_CHECKING
8 |
9 | import click
10 |
11 | from shelloracle.cli.application import Application
12 | from shelloracle.cli.config import config
13 | from shelloracle.config import Configuration
14 | from shelloracle.shelloracle import shelloracle
15 | from shelloracle.tty_log_handler import TtyLogHandler
16 |
17 | if TYPE_CHECKING:
18 | from pathlib import Path
19 |
20 | logger = logging.getLogger(__name__)
21 |
22 |
23 | def configure_logging(log_path: Path):
24 | root_logger = logging.getLogger()
25 | root_logger.setLevel(logging.DEBUG)
26 |
27 | file_formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(name)s - %(message)s")
28 | file_handler = logging.FileHandler(log_path)
29 | file_handler.setLevel(logging.DEBUG)
30 | file_handler.setFormatter(file_formatter)
31 |
32 | tty_formatter = logging.Formatter("%(message)s")
33 | tty_handler = TtyLogHandler()
34 | tty_handler.setLevel(logging.WARNING)
35 | tty_handler.setFormatter(tty_formatter)
36 |
37 | root_logger.addHandler(file_handler)
38 | root_logger.addHandler(tty_handler)
39 |
40 |
41 | @click.group(invoke_without_command=True)
42 | @click.version_option()
43 | @click.pass_context
44 | def cli(ctx: click.Context):
45 | """ShellOracle command line interface."""
46 | app = Application()
47 | configure_logging(app.log_path)
48 | ctx.obj = app
49 |
50 | if ctx.invoked_subcommand is not None:
51 | # If no subcommand is invoked, run the main CLI
52 | return
53 |
54 | try:
55 | app.configuration = Configuration.from_file(app.config_path)
56 | except FileNotFoundError:
57 | logger.warning("Configuration not found. Run `shor config init` to initialize.")
58 | sys.exit(1)
59 |
60 | asyncio.run(shelloracle(app))
61 |
62 |
63 | cli.add_command(config)
64 |
65 |
66 | def main():
67 | try:
68 | cli()
69 | except Exception: # noqa: BLE001
70 | import sys
71 |
72 | from rich.console import Console
73 |
74 | console = Console(stderr=True)
75 | shor_debug = os.getenv("SHOR_DEBUG") in {"1", "true"}
76 | console.print_exception(suppress=[click, asyncio], show_locals=shor_debug)
77 | sys.exit(1)
78 |
--------------------------------------------------------------------------------
/pyproject.toml:
--------------------------------------------------------------------------------
1 | [build-system]
2 | requires = ["hatchling", "hatch-vcs"]
3 | build-backend = "hatchling.build"
4 |
5 | [project]
6 | name = "shelloracle"
7 | description = """ShellOracle is a pluggable terminal utility that takes a natural language description of a \
8 | command and substitutes it into your terminal buffer."""
9 | readme = "README.md"
10 | license = { file = "LICENSE" }
11 | dynamic = ["version"]
12 | authors = [
13 | { name = "Daniel Copley", email = "djcopley@proton.me" },
14 | ]
15 | requires-python = ">=3.9"
16 | classifiers = [
17 | "Development Status :: 5 - Production/Stable",
18 | "Environment :: Console",
19 | "Operating System :: MacOS",
20 | "Operating System :: POSIX :: Linux",
21 | "Intended Audience :: Developers",
22 | "Programming Language :: Python :: 3",
23 | "Programming Language :: Python :: 3.9",
24 | "Programming Language :: Python :: 3.10",
25 | "Programming Language :: Python :: 3.11",
26 | "Programming Language :: Python :: 3.12",
27 | "Programming Language :: Python :: 3.13",
28 | "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
29 | ]
30 | dependencies = [
31 | "tomli ~= 2.1; python_version < '3.11'",
32 | "click~=8.1",
33 | "dspy~=2.6",
34 | "httpx~=0.28",
35 | "openai~=1.66",
36 | "prompt-toolkit~=3.0",
37 | "yaspin~=3.1",
38 | "tomlkit~=0.13",
39 | "google-generativeai~=0.8",
40 | "pygments~=2.19",
41 | "rich>=13.9.4",
42 | ]
43 |
44 | [dependency-groups]
45 | test = [
46 | "pytest~=8.3",
47 | "pytest-cov~=5.0",
48 | "pytest-sugar~=1.0",
49 | "pytest-xdist~=3.6",
50 | "pytest-asyncio~=0.24",
51 | "pytest-httpx~=0.30",
52 | "tomli-w~=1.2.0",
53 | ]
54 |
55 | [project.scripts]
56 | shor = "shelloracle.cli:main"
57 |
58 | [project.urls]
59 | Homepage = "https://github.com/djcopley/ShellOracle"
60 | Repository = "https://github.com/djcopley/ShellOracle.git"
61 | Issues = "https://github.com/djcopley/ShellOracle/issues"
62 |
63 | [tool.hatch.version]
64 | source = "vcs"
65 |
66 | [tool.hatch.envs.hatch-test]
67 | dependencies = [
68 | "pytest~=8.3",
69 | "pytest-cov~=5.0",
70 | "pytest-sugar~=1.0",
71 | "pytest-xdist~=3.6",
72 | "pytest-asyncio~=0.24",
73 | "pytest-httpx~=0.30",
74 | "tomli-w>=1.2.0",
75 | ]
76 |
77 | [[tool.hatch.envs.hatch-test.matrix]]
78 | python = ["3.9", "3.10", "3.11", "3.12", "3.13"]
79 |
80 | [tool.hatch.envs.types]
81 | template = "hatch-test"
82 | extra-dependencies = [
83 | "mypy~=1.0",
84 | "types-Pygments",
85 | ]
86 |
87 | [tool.hatch.envs.types.scripts]
88 | check = [
89 | "mypy {args:src/shelloracle}",
90 | "mypy --explicit-package-bases tests"
91 | ]
92 |
93 | [tool.hatch.envs.profile.scripts]
94 | importtime = "python -X importtime -m shelloracle 2> {args}"
95 |
96 | [tool.pytest.ini_options]
97 | pythonpath = "src"
98 | addopts = [
99 | "--import-mode=importlib",
100 | ]
101 | asyncio_default_fixture_loop_scope = "function"
102 |
103 | [tool.coverage.run]
104 | source = ["src/"]
105 | branch = true
106 | parallel = true
107 |
108 | [tool.coverage.report]
109 | exclude_lines = [
110 | "no cov",
111 | "if __name__ == .__main__.:",
112 | "if TYPE_CHECKING:",
113 | ]
114 |
115 | [tool.ruff.lint.extend-per-file-ignores]
116 | "tests/*" = ["INP001", "ARG"]
117 |
--------------------------------------------------------------------------------
/src/shelloracle/shelloracle.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | import logging
4 | import os
5 | import sys
6 | from pathlib import Path
7 | from typing import TYPE_CHECKING
8 |
9 | from prompt_toolkit import PromptSession
10 | from prompt_toolkit.application import create_app_session_from_tty
11 | from prompt_toolkit.history import FileHistory
12 | from prompt_toolkit.patch_stdout import patch_stdout
13 | from yaspin import yaspin
14 | from yaspin.spinners import Spinners
15 |
16 | from shelloracle.providers import get_provider
17 |
18 | if TYPE_CHECKING:
19 | from yaspin.core import Yaspin
20 |
21 | from shelloracle.cli import Application
22 |
23 | logger = logging.getLogger(__name__)
24 |
25 |
26 | async def prompt_user(default_prompt: str | None = None) -> str:
27 | # stdin doesn't exist when running as a zle widget
28 | with create_app_session_from_tty(), patch_stdout():
29 | history_file = Path.home() / ".shelloracle_history"
30 | prompt_session: PromptSession = PromptSession(history=FileHistory(str(history_file)))
31 | prompt_session.output.write_raw("\033[E")
32 | return await prompt_session.prompt_async("> ", default=default_prompt or "")
33 |
34 |
35 | def get_query_from_pipe() -> str | None:
36 | """Get a query from stdin pipe.
37 |
38 | :raises ValueError: If the input is more than one line
39 | :return: The query from the stdin pipe
40 | """
41 | if os.isatty(0) or not (lines := sys.stdin.readlines()): # Return 'None' if fd 0 is a tty (no pipe)
42 | return None
43 | if len(lines) > 1:
44 | msg = "Multi-line input is not supported"
45 | raise ValueError(msg)
46 | logger.debug("using query from stdin: %s", lines)
47 | return lines[0].rstrip()
48 |
49 |
50 | def spinner(style: str | None) -> Yaspin:
51 | """Get the correct spinner based on the user's configuration
52 |
53 | :param style: The spinner style
54 | :returns: yaspin object
55 | """
56 | if style:
57 | style = getattr(Spinners, style)
58 | return yaspin(style)
59 | return yaspin()
60 |
61 |
62 | async def shelloracle(app: Application) -> None:
63 | """ShellOracle program entrypoint
64 |
65 | If there is a query from the input pipe, it processes the query to generate a response.
66 | If there isn't a query from the input pipe, it prompts the user for input.
67 |
68 | Environment variables:
69 | - SHOR_DEFAULT_PROMPT: This is the initial user prompt that can be configured via this environment variable.
70 |
71 | :returns: None
72 | :raises KeyboardInterrupt: if the user presses CTRL+C
73 | """
74 | if not (prompt := get_query_from_pipe()):
75 | default_prompt = os.environ.get("SHOR_DEFAULT_PROMPT")
76 | prompt = await prompt_user(default_prompt)
77 | logger.info("user prompt: %s", prompt)
78 |
79 | provider = get_provider(app.configuration.provider)(app.configuration)
80 |
81 | shell_command = ""
82 | with create_app_session_from_tty(), patch_stdout(raw=True), spinner(app.configuration.spinner_style) as sp:
83 | async for token in provider.generate(prompt):
84 | # some models may erroneously return a newline, which causes issues with the status spinner
85 | shell_command += token.replace("\n", "")
86 | sp.text = shell_command
87 | logger.info("generated shell command: %s", shell_command)
88 | sys.stdout.write(shell_command)
89 |
--------------------------------------------------------------------------------
/src/shelloracle/providers/ollama.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | import json
4 | from dataclasses import asdict, dataclass
5 | from typing import TYPE_CHECKING, Any
6 |
7 | import httpx
8 |
9 | from shelloracle.providers import Provider, ProviderError, Setting, system_prompt
10 |
11 | if TYPE_CHECKING:
12 | from collections.abc import AsyncIterator
13 |
14 |
15 | def dataclass_to_json(obj: Any) -> dict[str, Any]:
16 | """Convert dataclass to a json dict
17 |
18 | This function filters out 'None' values.
19 |
20 | :param obj: the dataclass to serialize
21 | :return: serialized dataclass
22 | :raises TypeError: if obj is not a dataclass
23 | """
24 | return {k: v for k, v in asdict(obj).items() if v is not None}
25 |
26 |
27 | @dataclass
28 | class GenerateRequest:
29 | model: str
30 | """(required) the model name"""
31 | prompt: str | None = None
32 | """the prompt to generate a response for"""
33 | images: list[str] | None = None
34 | """a list of base64-encoded images (for multimodal models such as llava)"""
35 | format: str | None = None
36 | """the format to return a response in. Currently the only accepted value is json"""
37 | options: dict | None = None
38 | """additional model parameters listed in the documentation for the Modelfile such as temperature"""
39 | system: str | None = None
40 | """system prompt to (overrides what is defined in the Modelfile)"""
41 | template: str | None = None
42 | """the full prompt or prompt template (overrides what is defined in the Modelfile)"""
43 | context: str | None = None
44 | """the context parameter returned from a previous request to /generate, this can be used to keep a short
45 | conversational memory"""
46 | stream: bool | None = None
47 | """if false the response will be returned as a single response object, rather than a stream of objects"""
48 | raw: bool | None = None
49 | """if true no formatting will be applied to the prompt and no context will be returned. You may choose to use
50 | the raw parameter if you are specifying a full templated prompt in your request to the API, and are managing
51 | history yourself. JSON mode"""
52 |
53 |
54 | class Ollama(Provider):
55 | name = "Ollama"
56 |
57 | host = Setting(default="localhost")
58 | port = Setting(default=11434)
59 | model = Setting(default="dolphin-mistral")
60 |
61 | @property
62 | def endpoint(self) -> str:
63 | # computed property because python descriptors need to be bound to an instance before access
64 | return f"http://{self.host}:{self.port}/api/generate"
65 |
66 | async def generate(self, prompt: str) -> AsyncIterator[str]:
67 | request = GenerateRequest(self.model, prompt, system=system_prompt, stream=True)
68 | data = dataclass_to_json(request)
69 | try:
70 | async with (
71 | httpx.AsyncClient() as client,
72 | client.stream("POST", self.endpoint, json=data, timeout=20.0) as stream,
73 | ):
74 | async for line in stream.aiter_lines():
75 | response = json.loads(line)
76 | if "error" in response:
77 | raise ProviderError(response["error"])
78 | yield response["response"]
79 | except (httpx.HTTPError, httpx.StreamError) as e:
80 | msg = f"Something went wrong while querying Ollama: {e}"
81 | raise ProviderError(msg) from e
82 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 | *$py.class
5 |
6 | # C extensions
7 | *.so
8 |
9 | # Distribution / packaging
10 | .Python
11 | build/
12 | develop-eggs/
13 | dist/
14 | downloads/
15 | eggs/
16 | .eggs/
17 | lib/
18 | lib64/
19 | parts/
20 | sdist/
21 | var/
22 | wheels/
23 | share/python-wheels/
24 | *.egg-info/
25 | .installed.cfg
26 | *.egg
27 | MANIFEST
28 |
29 | # PyInstaller
30 | # Usually these files are written by a python script from a template
31 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
32 | *.manifest
33 | *.spec
34 |
35 | # Installer logs
36 | pip-log.txt
37 | pip-delete-this-directory.txt
38 |
39 | # Unit test / coverage reports
40 | htmlcov/
41 | .tox/
42 | .nox/
43 | .coverage
44 | .coverage.*
45 | .cache
46 | nosetests.xml
47 | coverage.xml
48 | *.cover
49 | *.py,cover
50 | .hypothesis/
51 | .pytest_cache/
52 | cover/
53 |
54 | # Translations
55 | *.mo
56 | *.pot
57 |
58 | # Django stuff:
59 | *.log
60 | local_settings.py
61 | db.sqlite3
62 | db.sqlite3-journal
63 |
64 | # Flask stuff:
65 | instance/
66 | .webassets-cache
67 |
68 | # Scrapy stuff:
69 | .scrapy
70 |
71 | # Sphinx documentation
72 | docs/_build/
73 |
74 | # PyBuilder
75 | .pybuilder/
76 | target/
77 |
78 | # Jupyter Notebook
79 | .ipynb_checkpoints
80 |
81 | # IPython
82 | profile_default/
83 | ipython_config.py
84 |
85 | # pyenv
86 | # For a library or package, you might want to ignore these files since the code is
87 | # intended to run in multiple environments; otherwise, check them in:
88 | # .python-version
89 |
90 | # pipenv
91 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92 | # However, in case of collaboration, if having platform-specific dependencies or dependencies
93 | # having no cross-platform support, pipenv may install dependencies that don't work, or not
94 | # install all needed dependencies.
95 | #Pipfile.lock
96 |
97 | # poetry
98 | # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
99 | # This is especially recommended for binary packages to ensure reproducibility, and is more
100 | # commonly ignored for libraries.
101 | # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
102 | #poetry.lock
103 |
104 | # pdm
105 | # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
106 | #pdm.lock
107 | # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
108 | # in version control.
109 | # https://pdm.fming.dev/#use-with-ide
110 | .pdm.toml
111 |
112 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
113 | __pypackages__/
114 |
115 | # Celery stuff
116 | celerybeat-schedule
117 | celerybeat.pid
118 |
119 | # SageMath parsed files
120 | *.sage.py
121 |
122 | # Environments
123 | .env
124 | .venv
125 | env/
126 | venv/
127 | ENV/
128 | env.bak/
129 | venv.bak/
130 |
131 | # Spyder project settings
132 | .spyderproject
133 | .spyproject
134 |
135 | # Rope project settings
136 | .ropeproject
137 |
138 | # mkdocs documentation
139 | /site
140 |
141 | # mypy
142 | .mypy_cache/
143 | .dmypy.json
144 | dmypy.json
145 |
146 | # Pyre type checker
147 | .pyre/
148 |
149 | # pytype static type analyzer
150 | .pytype/
151 |
152 | # Cython debug symbols
153 | cython_debug/
154 |
155 | # Jetbrains folder
156 | .idea/
157 |
158 | # Installer dependencies
159 | /installer/installer/**/*
160 |
161 | # Demo scripts
162 | demo/
163 |
164 | # Experimental scripts
165 | experiments/
166 |
167 | # Jujutsu VCS
168 | /.jj/
169 |
170 | # macos
171 | .DS_Store
172 |
--------------------------------------------------------------------------------
/src/shelloracle/providers/__init__.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | import abc
4 | from abc import abstractmethod
5 | from typing import TYPE_CHECKING, Generic, TypeVar
6 |
7 | if TYPE_CHECKING:
8 | from collections.abc import AsyncIterator
9 |
10 | from shelloracle.config import Configuration
11 |
12 | system_prompt = (
13 | "Based on the following user description, generate a corresponding shell command. Focus solely "
14 | "on interpreting the requirements and translating them into a single, executable Bash command. "
15 | "Ensure accuracy and relevance to the user's description. The output should be a valid shell "
16 | "command that directly aligns with the user's intent, ready for execution in a command-line "
17 | "environment. Do not output anything except for the command. No code block, no English explanation, "
18 | "no newlines, and no start/end tags."
19 | )
20 |
21 |
22 | class ProviderError(Exception):
23 | """LLM providers raise this error to gracefully indicate something has gone wrong."""
24 |
25 |
26 | class Provider(abc.ABC):
27 | """
28 | LLM Provider Protocol
29 |
30 | All LLM backends must implement this interface.
31 | """
32 |
33 | name: str
34 | config: Configuration
35 |
36 | def __init__(self, config: Configuration) -> None:
37 | """Initialize the provider with the given configuration.
38 |
39 | :param config: the configuration object
40 | :return: none
41 | """
42 | self.config = config
43 |
44 | @abstractmethod
45 | def generate(self, prompt: str) -> AsyncIterator[str]:
46 | """
47 | This is an asynchronous generator method which defines the protocol that a provider implementation
48 | should adhere to. The method takes a prompt as an argument and produces an asynchronous stream
49 | of string results.
50 |
51 | :param prompt: A string value which serves as input to the provider's process of generating results.
52 | :return: An asynchronous generator yielding string results.
53 | """
54 | # If you are wondering why the 'generate' signature doesn't include 'async', see
55 | # https://mypy.readthedocs.io/en/stable/more_types.html#asynchronous-iterators
56 |
57 |
58 | T = TypeVar("T")
59 |
60 |
61 | class Setting(Generic[T]):
62 | def __init__(self, *, name: str | None = None, default: T | None = None) -> None:
63 | self.name = name
64 | self.default = default
65 |
66 | def __set_name__(self, owner: type[Provider], name: str) -> None:
67 | if not self.name:
68 | self.name = name
69 |
70 | def __get__(self, instance: Provider, owner: type[Provider]) -> T:
71 | if instance is None:
72 | # Accessing settings as a class attribute is not supported because it prevents
73 | # inspect.get_members from determining the object type
74 | msg = "Settings must be accessed through a provider instance."
75 | raise AttributeError(msg)
76 | try:
77 | return instance.config["provider"][owner.name][self.name]
78 | except KeyError:
79 | if self.default is None:
80 | raise
81 | return self.default
82 |
83 |
84 | def _providers() -> dict[str, type[Provider]]:
85 | from shelloracle.providers.deepseek import Deepseek
86 | from shelloracle.providers.google import Google
87 | from shelloracle.providers.localai import LocalAI
88 | from shelloracle.providers.ollama import Ollama
89 | from shelloracle.providers.openai import OpenAI
90 | from shelloracle.providers.openai_compat import OpenAICompat
91 | from shelloracle.providers.xai import XAI
92 |
93 | return {
94 | Ollama.name: Ollama,
95 | OpenAI.name: OpenAI,
96 | OpenAICompat.name: OpenAICompat,
97 | LocalAI.name: LocalAI,
98 | XAI.name: XAI,
99 | Deepseek.name: Deepseek,
100 | Google.name: Google,
101 | }
102 |
103 |
104 | def get_provider(name: str) -> type[Provider]:
105 | """Imports and loads a requested provider
106 |
107 | :param name: the provider name
108 | :return: the requested provider
109 | """
110 |
111 | return _providers()[name]
112 |
113 |
114 | def list_providers() -> list[str]:
115 | return list(_providers())
116 |
--------------------------------------------------------------------------------
/src/shelloracle/bootstrap.py:
--------------------------------------------------------------------------------
1 | from __future__ import annotations
2 |
3 | import inspect
4 | import shutil
5 | from pathlib import Path
6 | from typing import TYPE_CHECKING, Any
7 |
8 | import tomlkit
9 | from prompt_toolkit import print_formatted_text, prompt
10 | from prompt_toolkit.completion import WordCompleter
11 | from prompt_toolkit.formatted_text import FormattedText
12 | from prompt_toolkit.shortcuts import confirm
13 |
14 | from shelloracle.providers import Provider, Setting, get_provider, list_providers
15 |
16 | if TYPE_CHECKING:
17 | from collections.abc import Iterator, Sequence
18 |
19 |
20 | class UserError(Exception): ...
21 |
22 |
23 | def print_info(info: str) -> None:
24 | print_formatted_text(FormattedText([("ansiblue", info)]))
25 |
26 |
27 | def print_warning(warning: str) -> None:
28 | print_formatted_text(FormattedText([("ansiyellow", warning)]))
29 |
30 |
31 | def print_error(error: str) -> None:
32 | print_formatted_text(FormattedText([("ansired", error)]))
33 |
34 |
35 | def replace_home_with_tilde(path: Path) -> Path:
36 | relative_path = path.relative_to(Path.home())
37 | return Path("~") / relative_path
38 |
39 |
40 | supported_shells = ("zsh", "bash", "fish")
41 |
42 |
43 | def get_installed_shells() -> list[str]:
44 | return [shell for shell in supported_shells if shutil.which(shell)]
45 |
46 |
47 | def get_bundled_script_path(shell: str) -> Path:
48 | shell_dir = Path(__file__).parent / "shell"
49 | if shell == "zsh":
50 | return shell_dir / "shelloracle.zsh"
51 | if shell == "fish":
52 | return shell_dir / "shelloracle.fish"
53 | return shell_dir / "shelloracle.bash"
54 |
55 |
56 | def get_script_path(shell: str) -> Path:
57 | if shell == "zsh":
58 | return Path.home() / ".shelloracle.zsh"
59 | if shell == "fish":
60 | return Path.home() / ".shelloracle.fish"
61 | return Path.home() / ".shelloracle.bash"
62 |
63 |
64 | def get_rc_path(shell: str) -> Path:
65 | if shell == "zsh":
66 | return Path.home() / ".zshrc"
67 | if shell == "fish":
68 | return Path.home() / ".config/fish/config.fish"
69 | return Path.home() / ".bashrc"
70 |
71 |
72 | def write_script_home(shell: str) -> None:
73 | shelloracle = get_bundled_script_path(shell).read_bytes()
74 | destination = get_script_path(shell)
75 | destination.write_bytes(shelloracle)
76 | print_info(f"Successfully wrote key bindings to {replace_home_with_tilde(destination)}")
77 |
78 |
79 | def update_rc(shell: str) -> None:
80 | rc_path = get_rc_path(shell)
81 | rc_path.touch(exist_ok=True)
82 | with rc_path.open("r") as file:
83 | rc_content = file.read()
84 | if shell == "fish":
85 | line = f"if test -f {get_script_path(shell)}; source {get_script_path(shell)}; end"
86 | else:
87 | shelloracle_script = get_script_path(shell)
88 | line = f"[ -f {shelloracle_script} ] && source {shelloracle_script}"
89 | if line not in rc_content:
90 | with rc_path.open("a") as file:
91 | file.write("\n")
92 | file.write(line)
93 | print_info(f"Successfully updated {replace_home_with_tilde(rc_path)}")
94 |
95 |
96 | def get_settings(provider: type[Provider]) -> Iterator[tuple[str, Setting]]:
97 | settings = inspect.getmembers(provider, predicate=lambda p: isinstance(p, Setting))
98 |
99 | def correct_name_setting():
100 | for name, setting in settings:
101 | yield setting.name or name, setting
102 |
103 | yield from correct_name_setting()
104 |
105 |
106 | def write_shelloracle_config(provider: type[Provider], settings: dict[str, Any], config_path: Path) -> None:
107 | config = tomlkit.document()
108 |
109 | shor_table = tomlkit.table()
110 | shor_table.add("provider", provider.name)
111 | config.add("shelloracle", shor_table)
112 |
113 | provider_table = tomlkit.table()
114 | config.add("provider", provider_table)
115 |
116 | provider_configuration_table = tomlkit.table()
117 | for setting, value in settings.items():
118 | provider_configuration_table.add(setting, value)
119 | provider_table.add(provider.name, provider_configuration_table)
120 |
121 | with config_path.open("w") as config_file:
122 | tomlkit.dump(config, config_file)
123 |
124 |
125 | def install_keybindings() -> None:
126 | if not (shells := get_installed_shells()):
127 | print_warning(
128 | "Cannot install keybindings: no compatible shells found. " f"Supported shells: {' '.join(supported_shells)}"
129 | )
130 | return
131 | if confirm("Enable terminal keybindings and update rc?", suffix=" ([y]/n) ") is False:
132 | return
133 | for shell in shells:
134 | write_script_home(shell)
135 | update_rc(shell)
136 |
137 |
138 | def user_configure_settings(provider: type[Provider]) -> dict[str, Any]:
139 | settings = {}
140 | for name, setting in get_settings(provider):
141 | user_input = prompt(f"{name}: ", default=str(setting.default))
142 | type_ = type(setting.default) if setting.default else str
143 | value = type_(user_input) # type: ignore[operator]
144 | settings[name] = value
145 | return settings
146 |
147 |
148 | def case_correct_user_input(user_input: str, options: Sequence[str]) -> str | None:
149 | for option in options:
150 | if user_input.lower() == option.lower():
151 | return option
152 | return None
153 |
154 |
155 | def user_select_provider() -> type[Provider]:
156 | providers = list_providers()
157 | completer = WordCompleter(providers, ignore_case=True)
158 | user_selected_provider = prompt(f"Choose your LLM provider ({', '.join(providers)}): ", completer=completer)
159 | if (provider_name := case_correct_user_input(user_selected_provider, providers)) is None:
160 | msg = f"Invalid provider: {user_selected_provider or 'no input'}"
161 | raise UserError(msg)
162 | return get_provider(provider_name)
163 |
164 |
165 | def bootstrap_shelloracle(config_path: Path) -> None:
166 | try:
167 | provider = user_select_provider()
168 | settings = user_configure_settings(provider)
169 | except UserError as e:
170 | print_error(str(e))
171 | return
172 | except KeyboardInterrupt:
173 | return
174 | write_shelloracle_config(provider, settings, config_path)
175 | install_keybindings()
176 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 |
2 | 
3 |
4 |
5 | ShellOracle
6 |
7 |
8 | 
9 |
10 |
11 | ShellOracle is an innovative terminal utility designed for intelligent shell command generation, bringing a new level of
12 | efficiency to your command-line interactions. ShellOracle currently supports Ollama, OpenAI, Deepseek, LocalAI, and Grok!
13 |
14 | 
15 |
16 | Show your support for ShellOracle and keep an eye out for exciting new developments by clicking the ⭐ and a 👀!
17 |
18 | ## Table of Contents
19 |
20 | - [Features](#features)
21 | - [Installation](#installation)
22 | - [Usage](#usage)
23 | - [Providers](#providers)
24 | - [Configuration](#configuration)
25 | - [System Requirements](#system-requirements)
26 | - [Feedback](#feedback)
27 |
28 | ## Features
29 |
30 | Key features of ShellOracle include:
31 |
32 | * Seamless shell command generation from written descriptions
33 | * Command history for easy reference
34 | * Unix pipe support for advanced command chaining
35 | * Self-hosted for full control over your environment
36 | * Highly configurable to adapt to your preferences
37 |
38 | ## Installation
39 |
40 | Installing ShellOracle is easy!
41 |
42 | 1. [pipx](https://pipx.pypa.io/latest/) install the `shelloracle` package
43 | ```shell
44 | pipx install shelloracle
45 | ```
46 | 2. Configure ShellOracle and follow the prompts
47 | ```shell
48 | shor config init
49 | ```
50 | 3. Refer to the [providers](#providers) section for specific details regarding your chosen provider.
51 |
52 | Upgrading to the latest version of ShellOracle is just as simple!
53 |
54 | 1. pipx upgrade the `shelloracle` package
55 | ```shell
56 | pipx upgrade shelloracle
57 | ```
58 |
59 | *Installation with `pip` is supported, however, `pipx` is preferred for its automatic environment isolation.*
60 |
61 | ## Usage
62 |
63 | ShellOracle is designed to be used as a BASH/ZSH/fish widget activated by the CTRL+F keyboard shortcut.
64 |
65 | 1. Press CTRL+F
66 | 2. Describe your command
67 | 3. Press Enter
68 |
69 | The generated command will be inserted into your shell prompt after a brief processing period.
70 |
71 | ### Other ways to run ShellOracle
72 |
73 | ShellOracle can be run as a Python module with `python3 -m shelloracle` or using its entrypoint `shor`, however,
74 | running ShellOracle with this method will not automatically insert the result into your shell prompt.
75 |
76 | ### Tips
77 |
78 | 1. If you press CTRL+F with text in your ZLE buffer, all text left of your cursor will carry over to your ShellOracle
79 | prompt.
80 | 2. ⬆️ arrow and ⬇️ arrow cycle through your prompt history.
81 | 3. ShellOracle can be chained with other commands; try: `echo "find all the python files in my cwd" | shor`
82 |
83 | ## Providers
84 |
85 | ### Ollama
86 |
87 | Before using ShellOracle with Ollama, pull the model you chose in the configure step.
88 | For example, if you chose `dolphin-mistral`, run:
89 |
90 | ```shell
91 | ollama pull dolphin-mistral
92 | ```
93 |
94 | Refer to the [Ollama docs](https://ollama.ai) for installation, available models, and usage.
95 |
96 | ### OpenAI
97 |
98 | To use ShellOracle with OpenAI's models, create an [API key](https://platform.openai.com/account/api-keys). Edit
99 | your `~/.shelloracle/config.toml` to change your provider and enter your API key.
100 | You can use `shor config edit` as a shorthand to edit this file.
101 |
102 | ### Deepseek
103 |
104 | To use ShellOracle with Deepseek's models, create an [API key](https://platform.deepseek.com/api_keys). Edit
105 | your `~/.shelloracle/config.toml` to change your provider and enter your API key.
106 | You can use `shor config edit` as a shorthand to edit this file.
107 |
108 | ### LocalAI
109 |
110 | Refer to the [LocalAI docs](https://localai.io/) for installation, available models, and usage.
111 |
112 | ### LM Studio
113 |
114 | To use ShellOracle with [LM Studio](https://lmstudio.ai/), you will first need to run a model and start the server.
115 | For macOS users, it's recommended to utillize a model that is using the MLX runtime.
116 |
117 | Here is an example configuration:
118 |
119 | ```toml
120 | [shelloracle]
121 | provider = "OpenAICompat"
122 |
123 | [provider.OpenAICompat]
124 | base_url = "http://localhost:1234/v1"
125 | api_key = "lm-studio"
126 | model = "mistralai/devstral-small-2507"
127 | ```
128 |
129 | ### XAI
130 |
131 | To use ShellOracle with XAI's models, create an [API key](https://docs.x.ai/docs/quickstart#creating-an-api-key).
132 | Edit your `~/.shelloracle/config.toml` to change your provider and enter your API key.
133 | You can use `shor config edit` as a shorthand to edit this file.
134 |
135 | ### Google
136 |
137 | To use ShellOracle with Google's models, create an [API key](https://aistudio.google.com/app/apikey).
138 | Edit your `~/.shelloracle/config.toml` to change your provider and enter your API key.
139 | You can use `shor config edit` as a shorthand to edit this file.
140 |
141 | ## Configuration
142 |
143 | ShellOracle's configuration is your gateway to tailoring the utility to match your preferences and requirements.
144 | The `~/.shelloracle/config.toml` file serves as the control center for customizing various aspects of ShellOracle's
145 | behavior. You can quickly access and edit this file using the command `shor config edit`.
146 |
147 | ## System Requirements
148 |
149 | ### Software
150 |
151 | ShellOracle supports BASH, ZSH and fish on macOS and Linux.
152 |
153 | ### Hardware
154 |
155 | For cloud providers like OpenAI, there are no hardware requirements.
156 |
157 | If running locally, refer to your model for hardware requirements.
158 |
159 | ## Feedback
160 |
161 | Encountered problems? [File an issue](https://github.com/djcopley/ShellOracle/issues/new). Feature requests are welcome,
162 | and contributions can be made by opening a pull request.
163 |
164 | ## License
165 |
166 | This software is licensed under the GPLv3 license.
167 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 |
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------