This repository has been archived by the owner on Oct 21, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.md.tpl
66 lines (45 loc) · 2.13 KB
/
README.md.tpl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
[![License](https://img.shields.io/badge/license-MIT-_red.svg)](https://opensource.org/licenses/MIT)
[![Follow on Twitter](https://img.shields.io/twitter/follow/pownjs.svg?logo=twitter)](https://twitter.com/pownjs)
[![NPM](https://img.shields.io/npm/v/@pown/script.svg)](https://www.npmjs.com/package/@pown/script)
[![Fury](https://img.shields.io/badge/version-2x%20Fury-red.svg)](https://github.com/pownjs/lobby)
![default workflow](https://github.com/pownjs/git/actions/workflows/default.yaml/badge.svg)
[![SecApps](https://img.shields.io/badge/credits-SecApps-black.svg)](https://secapps.com)
# Pown Script
Pown Script is a simple scripting environment. The key advantage of using Pown Script instead of Bash, Python, Perl, etc, is because all commands are executed within the same VM context (same process). Commands such as [Pown Recon](https://github.com/pownjs/pown-script) take advantage of this by keeping a global model of its graph, thus, removing the need to save into intermediate files upon each command execution.
Pown Script implements some some standard commands such as `echo`, `sleep` and even `set`. This is done for interoperability. Every pown script is also a valid bash script.
## Credits
This tool is part of [secapps.com](https://secapps.com) open-source initiative.
```
___ ___ ___ _ ___ ___ ___
/ __| __/ __| /_\ | _ \ _ \/ __|
\__ \ _| (__ / _ \| _/ _/\__ \
|___/___\___/_/ \_\_| |_| |___/
https://secapps.com
```
## Quickstart
This tool is meant to be used as part of [Pown.js](https://github.com/pownjs/pown) but it can be invoked separately as an independent tool.
Install Pown first as usual:
```sh
$ npm install -g pown@latest
```
Invoke directly from Pown:
```sh
$ pown script
```
Otherwise, install this module locally from the root of your project:
```sh
$ npm install @pown/script --save
```
Once done, invoke pown cli:
```sh
$ ./node_modules/.bin/pown-cli script
```
You can also use the global pown to invoke the tool locally:
```sh
$ POWN_ROOT=. pown script
```
## Usage
> **WARNING**: This pown command is currently under development and as a result will be subject to breaking changes.
```
{{usage}}
```