shellm

Name	shellm JSON
Version	0.4.1 JSON
	download
home_page
Summary
upload_time	2023-09-24 06:12:58
maintainer
docs_url	None
author	Gabriel Altay
requires_python	>=3.9
license
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # shellm

Use OpenAI LLMs from the command line.

# Quick Start

Install
```bash
pip install shellm
```

Export OpenAI key
```bash
export OPENAI_API_KEY=sk-...
```

View commands
```bash
shellm --help
```

## Completions

View completion help
```bash
shellm completion --help
```

Create a simple completion
```bash
shellm completion --prompt "Once upon a time" --max-tokens 128 --stream --echo
```

## Chat

View chat help
```bash
shellm chat --help
```

Create a simple chat completion
```bash
shellm chat --user-message "Tell me a story" --stream --max-tokens 128
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "shellm",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "",
    "author": "Gabriel Altay",
    "author_email": "gabriel.altay@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/ae/1b/3acbfe2b740878a1aad17df3dc693335878b2b9129dac8332aab57b3e1d5/shellm-0.4.1.tar.gz",
    "platform": null,
    "description": "# shellm\n\nUse OpenAI LLMs from the command line.\n\n# Quick Start\n\nInstall\n```bash\npip install shellm\n```\n\nExport OpenAI key\n```bash\nexport OPENAI_API_KEY=sk-...\n```\n\nView commands\n```bash\nshellm --help\n```\n\n## Completions\n\nView completion help\n```bash\nshellm completion --help\n```\n\nCreate a simple completion\n```bash\nshellm completion --prompt \"Once upon a time\" --max-tokens 128 --stream --echo\n```\n\n## Chat\n\nView chat help\n```bash\nshellm chat --help\n```\n\nCreate a simple chat completion\n```bash\nshellm chat --user-message \"Tell me a story\" --stream --max-tokens 128\n```\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "",
    "version": "0.4.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d6d17f51e12f95d307366c2bd3e7459df438537bcb2b16772322aea1b31024a4",
                "md5": "3696e6412f8ac43891fb52a5293041b6",
                "sha256": "753e31c218a32f596263be155c9264112a2d21d1743c98e6205df64812302852"
            },
            "downloads": -1,
            "filename": "shellm-0.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3696e6412f8ac43891fb52a5293041b6",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 7052,
            "upload_time": "2023-09-24T06:12:57",
            "upload_time_iso_8601": "2023-09-24T06:12:57.047333Z",
            "url": "https://files.pythonhosted.org/packages/d6/d1/7f51e12f95d307366c2bd3e7459df438537bcb2b16772322aea1b31024a4/shellm-0.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ae1b3acbfe2b740878a1aad17df3dc693335878b2b9129dac8332aab57b3e1d5",
                "md5": "c14c8d73c96f462d8851a5ec7c6305c7",
                "sha256": "4ab6e3462058dae04a7fe6f1d3baa385bc922d8c9ac65a203f39a320b042fabb"
            },
            "downloads": -1,
            "filename": "shellm-0.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "c14c8d73c96f462d8851a5ec7c6305c7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 6207,
            "upload_time": "2023-09-24T06:12:58",
            "upload_time_iso_8601": "2023-09-24T06:12:58.682564Z",
            "url": "https://files.pythonhosted.org/packages/ae/1b/3acbfe2b740878a1aad17df3dc693335878b2b9129dac8332aab57b3e1d5/shellm-0.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-09-24 06:12:58",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "shellm"
}