https://github.com/andostronaut/weal

Web interface for terminal
https://github.com/andostronaut/weal

cli command-line-tool interface internal javascript node react terminal terminal-ui web

Last synced: about 9 hours ago
JSON representation

Web interface for terminal

• Host: GitHub
• URL: https://github.com/andostronaut/weal
• Owner: andostronaut
• License: mit
• Created: 2023-03-25T08:20:23.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-06-26T18:09:49.000Z (over 1 year ago)
• Last Synced: 2024-10-02T03:33:45.427Z (3 days ago)
• Topics: cli, command-line-tool, interface, internal, javascript, node, react, terminal, terminal-ui, web
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/weal
• Size: 3.67 MB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Weal

![build](https://github.com/iamando/weal/workflows/build/badge.svg)

![license](https://img.shields.io/github/license/iamando/weal?color=success)

![npm](https://img.shields.io/npm/v/weal)

![release](https://img.shields.io/github/release-date/iamando/weal)

![codebase](https://github.com/iamando/weal/workflows/codebase/badge.svg)

Web interface for terminal

![Demo](docs/demo.png)

## Install

```bash

# recommended

npx weal

# using npm global installation

npm install -g weal

# using yarn global installation

yarn add global weal

```

## Command-line Interface (CLI)

Now, you can open any directory via the command **open**

```bash

# recommended

npx weal open

# using global installation

weal open

```

The following is the help text from the weal cli. To see this and more information anytime,add the **help** command to your call.

```bash

# recommended

npx weal help

# using global installation

weal help

```

Check version of weal with **version** command

```bash

# recommended

npx weal version

# using global installation

weal version

```

## Tips

On windows before installing it globally you need to set your config prefix to avoid error when opening directory

```bash

npm config set prefix c:/Users/{userName}/AppData/Roaming/npm

```

## Support

Weal is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers.

## License

Weal is [MIT licensed](LICENSE).