Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fugazi-io/webclient
web based terminal application for executing local and remote commands
https://github.com/fugazi-io/webclient
cli cli-client console dsl fugazi rpc rpc-client shell terminal
Last synced: 1 day ago
JSON representation
web based terminal application for executing local and remote commands
- Host: GitHub
- URL: https://github.com/fugazi-io/webclient
- Owner: fugazi-io
- Created: 2017-01-28T20:12:13.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-01-07T23:41:42.000Z (almost 7 years ago)
- Last Synced: 2024-11-10T10:49:46.627Z (6 days ago)
- Topics: cli, cli-client, console, dsl, fugazi, rpc, rpc-client, shell, terminal
- Language: TypeScript
- Homepage: http://fugazi.io
- Size: 4.19 MB
- Stars: 28
- Watchers: 5
- Forks: 12
- Open Issues: 44
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# fugazi.io
A web based terminal application for executing local and remote commands.
The latest version of the terminal can be found here: http://fugazi.io.
Here's a short introduction video:
[](https://www.youtube.com/watch?v=lKf1rhJdonI)
Documentation can be found here: https://fugazi-io.github.io.
You can contact us here: https://gitter.im/fugazi-io/Lobby.
### Short example
Fugazi isn't a regular terminal, it won't execute the commands which you are used to.
In order to execute commands you need to load modules into the client, these modules will define the
commands which can be executed.
The client comes with a some [built-in commands](./docs/builtins/commands.md), and here's a short
example of what you can do with it:
In the fugazi terminal try to execute:
```
get "https://jsonplaceholder.typicode.com/posts/1"
```
This command will make an http GET request to that url and output the response.
(you can use other urls of course, as long as they support [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS)).
If you only want to get the data from the response you can do so like this:
```
r = (get "https://jsonplaceholder.typicode.com/posts/1")
extract data from $r
```
Here we used a variable to hold the response and then extracted the data part from it,
but you can do it in one line using nested commands:
```
extract data from (get "https://jsonplaceholder.typicode.com/posts/1")
```
The only problem left though is that the return value is a string and not a map.
This happens because the response doesn't have json content type.
It's easy to go around it though:
```
r = (get "https://jsonplaceholder.typicode.com/posts/1")
d = (extract data from $r)
json parse $d
```
Or, in one line:
```
json parse (extract data from (get "https://jsonplaceholder.typicode.com/posts/1"))
```
### Installation
The client requires no servers, other than hosting the static files (scripts, styles, etc).
To run locally install the [npm package](https://www.npmjs.com/package/@fugazi/webclient):
```bash
npm install @fugazi/webclient
```
Then build the scripts:
```bash
npm run transpile
```
After the compilation ended, serve the files:
```bash
npm run serve
```
That's it, you have fugazi locally served, open [http://localhost:3330/index.hml](http://localhost:3330/index.hml) in your browser.
### Development
If you want to develop with/for fugazi then you better clone this repo.
Here's how to run it locally:
1. Clone the repo and change into the directory
1. Install the dependencies: `$ npm install`
1. Run `$ npm run dev` (read the `dev` npm script in `package.json` for more information)
1. Open the provided URL in the browser.
### Features
1. Executing of local (js) commands and remote (HTTP) commands
2. Remote commands can be issues directly if the server supports CORS, or a proxy frame can be hosted in the server to support non-CORS
3. Remote authentication (currently only basic auth is supported)
4. Commands syntax is determined by the command author
5. Type validation
6. Composing of new types
7. Commands suggestions
1. Press `TAB` to open the suggestions box
2. Press `ESC` to close the suggestion box
3. While open, `TAB` can be used to switch to _selection mode_ and back to _input mode_
4. While in _selection mode_, press `ENTER` to select a suggestion
8. Move in the command history (by pressing the up & down arrows)
9. Search for command in history (press `CTRL + R` then start typing and `ENTER` to select, `ESC` to close)
### More documentation
There's a new documentation site here: https://fugazi-io.github.io, this is the old version:
#### Components
* [Components basics](docs/components/components.md)
* [Modules](docs/components/modules.md)
* [Types](docs/components/types.md)
* [Constraints](docs/components/constraints.md)
* [Converters](docs/components/converters.md)
* [Commands](docs/components/commands.md)
#### Descriptors
* [Descriptors basics](docs/descriptors/component.md)
* [Module Descriptors](docs/descriptors/module.md)
* [Type Descriptors](docs/descriptors/type.md)
* [Constraint Descriptors](docs/descriptors/constraint.md)
* [Converter Descriptors](docs/descriptors/converter.md)
* [Command Descriptors](docs/descriptors/command.md)
#### Builtin Components
* [Types](./docs/builtins/types.md)
* [Commands](./docs/builtins/commands.md)
* [Constraints](./docs/builtins/constraints.md)
* [Converters](./docs/builtins/converters.md)
### Connectors
* [Connectors](./docs/connectors/connectors.md)
* [Expose an existing http based api](./docs/connectors/existing-service.md)
#### Examples
* [Simple Math Module](./docs/examples/math.md)
#### Getting help
Use the [issues](//github.com/fugazi-io/webclient/issues) for any bug, request, question.
Or you can find us in [our gitter](https://gitter.im/fugazi-io/Lobby)
### Contribution
We're looking for more help, if you're interested find us in this `gmail.com` address: `terminal.fugazi.io`