open-shell-ai 0.0.1__tar.gz

open_shell_ai-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

open_shell_ai-0.0.1/MANIFEST.in

@@ -0,0 +1,11 @@
+include LICENSE
+include README.md
+include openshell.py
+graft command
+graft registry
+prune image
+prune skills
+prune .venv
+prune build
+prune dist
+global-exclude __pycache__ *.py[cod] .DS_Store

open_shell_ai-0.0.1/PKG-INFO

@@ -0,0 +1,245 @@
+Metadata-Version: 2.4
+Name: open-shell-ai
+Version: 0.0.1
+Summary: Open Shell - a JSON-pipeline shell. pip ships the core; extras come from the website registry.
+Author: World Programming Society
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://openshell.dev
+Project-URL: Registry, https://openshell.dev/registry
+Keywords: shell,json,pipeline,cli,ai,mcp
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: System :: Shells
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# Open Shell
+
+![Open Shell](image/image1.png)
+
+A cross-platform shell whose pipeline carries **JSON**, not text.
+
+Bash pipes text. PowerShell pipes .NET objects. Open Shell pipes JSON records —
+so every stage is structured, and the same pipeline works on Linux, macOS, and
+Windows.
+
+```text
+oshell> fs.ls -r . | where .size > 10kb | sort-by .size --desc | take 5
+```
+
+Status: **0.0.1** (pre-alpha). Python 3.12+, standard library only.
+
+The PyPI name is `open-shell-ai` (`openshell` and `open-shell` are taken). The
+command you run is `openshell`.
+
+```bash
+pip install open-shell-ai
+openshell --version
+```
+
+From this repo, without publishing:
+
+```bash
+python3 -m venv .venv
+.venv/bin/pip install -e .
+.venv/bin/openshell -c 'help'
+# or:  ./openshell.py -c 'help'
+```
+
+`pip` ships the **core + basic commands**. Extra and advanced commands are not
+on PyPI — they live on the website registry.
+
+## Quick start
+
+```bash
+# Interactive shell
+openshell
+
+# One pipeline, then exit
+openshell -c 'fs.ls'
+openshell -c 'fs.ls -r . | where .size > 10kb | sort-by .size --desc | take 5'
+openshell -c 'help | select .name .summary'
+
+# Force NDJSON (also the default when stdout is not a TTY)
+openshell --json -c 'fs.ls | select .name .size'
+
+# Works inside bash / jq
+openshell -c 'fs.ls | select .name .size' | jq .name
+```
+
+On a terminal, the last stage renders a table. When piped, it writes one JSON
+object per line (NDJSON).
+
+## How the pipeline works
+
+Each command **yields records**. Only sinks (`to json`, `to table`) print.
+`|` passes the record stream downstream. `take 5` stops early, so
+`fs.ls -r /usr | take 3` does not walk the whole tree.
+
+```text
+fs.ls -r .          →  {name, path, is_dir, size, modified} …
+     | where .size > 10kb
+     | sort-by .size --desc
+     | take 5
+     | select .name .size
+     | to table
+```
+
+Predicates use a leading dot for fields. Size units (`10kb`, `1mb`) and
+`=~` (regex) are built in:
+
+```text
+where .size > 10mb
+where .name =~ "\.py$"
+where .is_dir
+```
+
+Errors are records, never raw tracebacks:
+
+```text
+{"$t": "error", "code": "cmd.not_found", "message": "…", "hint": "…"}
+```
+
+## Basic commands (ship with pip)
+
+| Command | Usage | What it does |
+|---|---|---|
+| `fs.ls` | `fs.ls [PATH] [-r] [-a]` | List files as records |
+| `where` | `where .FIELD [OP VALUE]` | Filter (`>`, `<`, `==`, `!=`, `>=`, `<=`, `=~`) |
+| `select` | `select .FIELD …` | Keep named fields |
+| `sort-by` | `sort-by .FIELD [--desc]` | Sort (buffers the stream) |
+| `take` | `take N` | First N records |
+| `to` | `to json\|table [--compact]` | Render the stream |
+| `help` | `help [NAME]` | List loaded commands as records |
+| `command` | `command` | Same idea: every command as a record |
+| `version` | `version` | Version and runtime |
+| `search` | `search [QUERY]` | List extras on the website registry |
+| `install` | `install NAME` | Download an extra into `~/.config/oshell/command/` |
+| `remove` | `remove NAME` | Remove a website extra (not a built-in) |
+
+`help` itself is a source command, so this works:
+
+```bash
+openshell -c 'help | select .name .usage .origin'
+```
+
+## Website extras (not on PyPI)
+
+Host the `registry/` folder so this URL exists:
+
+`https://openshell.dev/registry/index.json`
+
+```bash
+openshell -c 'search'
+openshell -c 'install count'
+openshell -c 'fs.ls | count'
+openshell -c 'remove count'
+```
+
+Until the site is live, use the copy in this repo:
+
+```bash
+export OSHELL_REGISTRY_URL="file://$PWD/registry"
+openshell -c 'search | to table'
+openshell -c 'install uniq'
+```
+
+Current extras in `registry/`:
+
+| Command | Usage | What it does |
+|---|---|---|
+| `count` | `count` | Count incoming records |
+| `uniq` | `uniq [.FIELD]` | Drop consecutive duplicates |
+
+`install` writes `~/.config/oshell/command/<file>.py` and checks the `sha256`
+in `registry/index.json`. Built-ins cannot be removed.
+
+## Writing a command
+
+One file per command. Drop it in `command/` (basic, ships with pip) or
+`registry/commands/` (website extra). The **decorator** is the name, not the
+filename: `sort_by.py` registers `sort-by`.
+
+```python
+from openshell import Records, command
+
+@command("greet", "Say hello as a record", "greet [NAME]", source=True)
+def greet(_input: Records, args: list[str]) -> Records:
+    yield {"hello": args[0] if args else "world"}
+```
+
+No registration step. Files starting with `_` are skipped. A broken file is
+reported and skipped; it does not kill the shell.
+
+User-local commands (no install):
+
+```text
+~/.config/oshell/command/my_cmd.py
+```
+
+Or any directory on `$OSHELL_COMMAND_PATH` (separated by `os.pathsep`).
+
+Load order, later wins on a name clash:
+
+1. `<install>/oshell_command/*.py` — basic set from pip
+2. `~/.config/oshell/command/*.py` — website extras and your files
+3. `$OSHELL_COMMAND_PATH`
+
+## CLI
+
+```text
+openshell                 start the interactive shell
+openshell -c PIPELINE     run one pipeline and exit
+openshell --json -c ...   force NDJSON output
+openshell --version
+openshell --help
+```
+
+| Variable | Meaning |
+|---|---|
+| `OSHELL_REGISTRY_URL` | Catalog root (default `https://openshell.dev/registry`) |
+| `OSHELL_COMMAND_PATH` | Extra command directories |
+| `NO_COLOR` | Disable ANSI color |
+
+## Repository
+
+```text
+openshell.py              core: registry, loader, pipeline, REPL
+command/                  basic commands (shipped on PyPI)
+registry/                 website extras (not in the wheel)
+  index.json              catalog + sha256
+  commands/*.py           one extra command per file
+skills/                   design plan and build steps
+image/                    banner
+```
+
+The repo folder is `command/`. It installs as `oshell_command/` so it does not
+squat the name `command` in `site-packages`.
+
+## Publish
+
+```bash
+pip install build twine
+rm -rf dist
+python -m build
+twine upload dist/open_shell_ai-*
+```
+
+Confirm extras stayed off the wheel:
+
+```bash
+unzip -l dist/open_shell_ai-*.whl | grep -E 'count|uniq|registry' || echo ok
+```
+
+Then upload `registry/` to `https://openshell.dev/registry`.
+
+## License
+
+Apache-2.0

open_shell_ai-0.0.1/README.md

@@ -0,0 +1,223 @@
+# Open Shell
+
+![Open Shell](image/image1.png)
+
+A cross-platform shell whose pipeline carries **JSON**, not text.
+
+Bash pipes text. PowerShell pipes .NET objects. Open Shell pipes JSON records —
+so every stage is structured, and the same pipeline works on Linux, macOS, and
+Windows.
+
+```text
+oshell> fs.ls -r . | where .size > 10kb | sort-by .size --desc | take 5
+```
+
+Status: **0.0.1** (pre-alpha). Python 3.12+, standard library only.
+
+The PyPI name is `open-shell-ai` (`openshell` and `open-shell` are taken). The
+command you run is `openshell`.
+
+```bash
+pip install open-shell-ai
+openshell --version
+```
+
+From this repo, without publishing:
+
+```bash
+python3 -m venv .venv
+.venv/bin/pip install -e .
+.venv/bin/openshell -c 'help'
+# or:  ./openshell.py -c 'help'
+```
+
+`pip` ships the **core + basic commands**. Extra and advanced commands are not
+on PyPI — they live on the website registry.
+
+## Quick start
+
+```bash
+# Interactive shell
+openshell
+
+# One pipeline, then exit
+openshell -c 'fs.ls'
+openshell -c 'fs.ls -r . | where .size > 10kb | sort-by .size --desc | take 5'
+openshell -c 'help | select .name .summary'
+
+# Force NDJSON (also the default when stdout is not a TTY)
+openshell --json -c 'fs.ls | select .name .size'
+
+# Works inside bash / jq
+openshell -c 'fs.ls | select .name .size' | jq .name
+```
+
+On a terminal, the last stage renders a table. When piped, it writes one JSON
+object per line (NDJSON).
+
+## How the pipeline works
+
+Each command **yields records**. Only sinks (`to json`, `to table`) print.
+`|` passes the record stream downstream. `take 5` stops early, so
+`fs.ls -r /usr | take 3` does not walk the whole tree.
+
+```text
+fs.ls -r .          →  {name, path, is_dir, size, modified} …
+     | where .size > 10kb
+     | sort-by .size --desc
+     | take 5
+     | select .name .size
+     | to table
+```
+
+Predicates use a leading dot for fields. Size units (`10kb`, `1mb`) and
+`=~` (regex) are built in:
+
+```text
+where .size > 10mb
+where .name =~ "\.py$"
+where .is_dir
+```
+
+Errors are records, never raw tracebacks:
+
+```text
+{"$t": "error", "code": "cmd.not_found", "message": "…", "hint": "…"}
+```
+
+## Basic commands (ship with pip)
+
+| Command | Usage | What it does |
+|---|---|---|
+| `fs.ls` | `fs.ls [PATH] [-r] [-a]` | List files as records |
+| `where` | `where .FIELD [OP VALUE]` | Filter (`>`, `<`, `==`, `!=`, `>=`, `<=`, `=~`) |
+| `select` | `select .FIELD …` | Keep named fields |
+| `sort-by` | `sort-by .FIELD [--desc]` | Sort (buffers the stream) |
+| `take` | `take N` | First N records |
+| `to` | `to json\|table [--compact]` | Render the stream |
+| `help` | `help [NAME]` | List loaded commands as records |
+| `command` | `command` | Same idea: every command as a record |
+| `version` | `version` | Version and runtime |
+| `search` | `search [QUERY]` | List extras on the website registry |
+| `install` | `install NAME` | Download an extra into `~/.config/oshell/command/` |
+| `remove` | `remove NAME` | Remove a website extra (not a built-in) |
+
+`help` itself is a source command, so this works:
+
+```bash
+openshell -c 'help | select .name .usage .origin'
+```
+
+## Website extras (not on PyPI)
+
+Host the `registry/` folder so this URL exists:
+
+`https://openshell.dev/registry/index.json`
+
+```bash
+openshell -c 'search'
+openshell -c 'install count'
+openshell -c 'fs.ls | count'
+openshell -c 'remove count'
+```
+
+Until the site is live, use the copy in this repo:
+
+```bash
+export OSHELL_REGISTRY_URL="file://$PWD/registry"
+openshell -c 'search | to table'
+openshell -c 'install uniq'
+```
+
+Current extras in `registry/`:
+
+| Command | Usage | What it does |
+|---|---|---|
+| `count` | `count` | Count incoming records |
+| `uniq` | `uniq [.FIELD]` | Drop consecutive duplicates |
+
+`install` writes `~/.config/oshell/command/<file>.py` and checks the `sha256`
+in `registry/index.json`. Built-ins cannot be removed.
+
+## Writing a command
+
+One file per command. Drop it in `command/` (basic, ships with pip) or
+`registry/commands/` (website extra). The **decorator** is the name, not the
+filename: `sort_by.py` registers `sort-by`.
+
+```python
+from openshell import Records, command
+
+@command("greet", "Say hello as a record", "greet [NAME]", source=True)
+def greet(_input: Records, args: list[str]) -> Records:
+    yield {"hello": args[0] if args else "world"}
+```
+
+No registration step. Files starting with `_` are skipped. A broken file is
+reported and skipped; it does not kill the shell.
+
+User-local commands (no install):
+
+```text
+~/.config/oshell/command/my_cmd.py
+```
+
+Or any directory on `$OSHELL_COMMAND_PATH` (separated by `os.pathsep`).
+
+Load order, later wins on a name clash:
+
+1. `<install>/oshell_command/*.py` — basic set from pip
+2. `~/.config/oshell/command/*.py` — website extras and your files
+3. `$OSHELL_COMMAND_PATH`
+
+## CLI
+
+```text
+openshell                 start the interactive shell
+openshell -c PIPELINE     run one pipeline and exit
+openshell --json -c ...   force NDJSON output
+openshell --version
+openshell --help
+```
+
+| Variable | Meaning |
+|---|---|
+| `OSHELL_REGISTRY_URL` | Catalog root (default `https://openshell.dev/registry`) |
+| `OSHELL_COMMAND_PATH` | Extra command directories |
+| `NO_COLOR` | Disable ANSI color |
+
+## Repository
+
+```text
+openshell.py              core: registry, loader, pipeline, REPL
+command/                  basic commands (shipped on PyPI)
+registry/                 website extras (not in the wheel)
+  index.json              catalog + sha256
+  commands/*.py           one extra command per file
+skills/                   design plan and build steps
+image/                    banner
+```
+
+The repo folder is `command/`. It installs as `oshell_command/` so it does not
+squat the name `command` in `site-packages`.
+
+## Publish
+
+```bash
+pip install build twine
+rm -rf dist
+python -m build
+twine upload dist/open_shell_ai-*
+```
+
+Confirm extras stayed off the wheel:
+
+```bash
+unzip -l dist/open_shell_ai-*.whl | grep -E 'count|uniq|registry' || echo ok
+```
+
+Then upload `registry/` to `https://openshell.dev/registry`.
+
+## License
+
+Apache-2.0

open_shell_ai-0.0.1/command/__init__.py

@@ -0,0 +1,3 @@
+# Present so packaging tools ship this folder inside the wheel, where it is
+# installed as `oshell_command/`. The shell loads these files by path, not by
+# import, so nothing here is executed. Files starting with `_` are skipped.