Metadata-Version: 2.5
Name: scify
Version: 0.1.1
Summary: Wrap your real shell in a sci-fi dashboard.
Project-URL: Homepage, https://github.com/crystalskim/scify
Project-URL: Issues, https://github.com/crystalskim/scify/issues
Author: C. S. Kim
License-Expression: MIT
License-File: LICENSE
Keywords: dashboard,sci-fi,shell,terminal,textual,tui
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Terminals
Requires-Python: >=3.10
Requires-Dist: platformdirs>=3
Requires-Dist: psutil>=5.9
Requires-Dist: textual-tty<0.5,>=0.4
Requires-Dist: textual>=8.2
Requires-Dist: tomli>=1.1; python_version < '3.11'
Description-Content-Type: text/markdown

# scify

Why should your IDE have all the fun? Wrap your real shell in a sci-fi dashboard.

![LCARS theme](https://raw.githubusercontent.com/crystalskim/scify/main/media/scify-lcars.gif)

![Matrix theme](https://raw.githubusercontent.com/crystalskim/scify/main/media/scify-matrix.gif)

![Cyberpunk theme](https://raw.githubusercontent.com/crystalskim/scify/main/media/scify-cyberpunk.gif)

Your usual shell (PowerShell, cmd, bash, zsh, fish) runs in the middle. As you `cd`, the panels around it show the folder you're in: subfolders, git status, project type and environment, one-click commands, TODOs and recently changed files.

## Install

```bash
pip install scify
```

Needs Python 3.10+ (on Windows, 3.10–3.13 for now).

- **Windows:** if `pip` isn't found or your Python is 3.14+, use `py -3.13 -m pip install scify`.
- **macOS / Linux:** if `pip` isn't found, use `python3 -m pip install scify`. If pip refuses with "externally-managed-environment" (Homebrew Python, Debian/Ubuntu, Fedora), use `pipx install scify` or uv instead.

No suitable Python, or just want to try it? [uv](https://docs.astral.sh/uv/) fetches one for you:

```bash
uvx scify               # try it without installing
uv tool install scify   # install it
```

On Windows, add `--python 3.13`, e.g. `uvx --python 3.13 scify`.

For the best look use a modern terminal with true colour, e.g. Windows Terminal, iTerm2, WezTerm, Kitty, Ghostty or GNOME Terminal, and a font with block characters (Cascadia Mono, JetBrains Mono, Fira Code).

## Use

```bash
scify                 # LCARS theme, your usual shell, current folder
scify matrix          # pick a theme: lcars, matrix, cyberpunk
scify -s bash         # pick the shell: pwsh, powershell, cmd, bash, zsh, fish
scify -C ~/projects   # start in another folder
```

Type `exit` in the shell to leave.

## Controls

Everything you type goes to the shell, except:

| Key | Does |
|---|---|
| **F1** | help |
| **F2** | next theme |
| **F3** | focus mode: hide the panels |
| **F4** / **F5** | start-pause / reset the focus timer |
| **F6** | bookmark / unbookmark the current folder |
| **F7** | refresh the panels |
| **Alt+1…9** | run quick action 1–9 |
| **Ctrl+Q** | quit |

With the mouse: click a folder to `cd` there, click a quick action to run it, click a recent file to paste its path at the prompt.

On macOS, F-keys may need **fn**, and Alt+1…9 needs "Option as Meta" (iTerm2: Profiles → Keys; Terminal: Settings → Profiles → Keyboard).

---

A fan-made project, not affiliated with or endorsed by any franchise. [MIT licensed](LICENSE).
