404
+ +Page not found
+ + +'+ escapeHtml(title) + '
' + escapeHtml(summary) +'
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aid bits eval
+ aid bits eval <EXPRESSION> Evaluates a bitwise expression, converts base, visualize binary / display info
+ -i, --info Output the bitboard representation.
+ -c, --chess Output the chess bitboard representation.
+ -b, --bin Output the result in binary.
+ --hex Output the result in hex.
+
+-----input-----
+aid bits eval 0b1001
+-----output-----
+9
+
+-----input-----
+aid bits eval --hex 0b10101001
+-----output-----
+a9
+
+-----input-----
+aid bits eval --bin 0xa9
+-----output-----
+10101001
+
+-----input-----
+aid bits eval --bin '0xa9 << 2 | (0b1010 & 7)'
+-----output-----
+1010100110
+
+-----input-----
+aid bits eval --info '!((0b11110000 ^ 0b00001111) << 8)'
+-----output-----
+FF | 1 1 1 1 1 1 1 1
+FF | 1 1 1 1 1 1 1 1
+FF | 1 1 1 1 1 1 1 1
+FF | 1 1 1 1 1 1 1 1
+FF | 1 1 1 1 1 1 1 1
+FF | 1 1 1 1 1 1 1 1
+00 | 0 0 0 0 0 0 0 0
+FF | 1 1 1 1 1 1 1 1
+ -----------------------
+ 7 6 5 4 3 2 1 0
+dec: 18446744073709486335
+hex: FFFFFFFFFFFF00FF
+bin: 1111111111111111111111111111111111111111111111110000000011111111
+lsb: 0
+msb: 63
+set bits: 56
+
+-----input-----
+aid bits eval --chess '!(0xFEFEFEFEFEFEFEFE << 8)'
+-----output-----
+8 | 1 0 0 0 0 0 0 0
+7 | 1 0 0 0 0 0 0 0
+6 | 1 0 0 0 0 0 0 0
+5 | 1 0 0 0 0 0 0 0
+4 | 1 0 0 0 0 0 0 0
+3 | 1 0 0 0 0 0 0 0
+2 | 1 0 0 0 0 0 0 0
+1 | 1 1 1 1 1 1 1 1
+ -----------------------
+ A B C D E F G H
+dec: 72340172838076927
+hex: 1010101010101FF
+bin: 100000001000000010000000100000001000000010000000111111111
+lsb: 0
+msb: 56
+set bits: 15
+
+
+
+
+ GitHub
+
+
+
+ « Previous
+
+
+ Next »
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/features/cpu/index.html b/features/cpu/index.html
new file mode 100644
index 0000000..81a540a
--- /dev/null
+++ b/features/cpu/index.html
@@ -0,0 +1,215 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aid cpu info
+ aid cpu info Show CPU information
+ -j, --json Output CPU information in JSON format.
+
+-----input-----
+aid cpu info
+
+-----output-----
+AMD Ryzen 9 5900HX with Radeon Graphics
+aid cpu usage
+ aid cpu usage Monitor CPU usage
+ -w, --watch Continuously monitor CPU usage.
+ -j, --json Output CPU usage in JSON format.
+ -p, --plot Plot total % cpu usage.
+
+-----input-----
+aid cpu usage -w -p
+
+-----output-----
+total: 6.0%, cpus: 18.6%, 2.3%, 12.7%, 1.6%, 11.2%, 7.0%, 8.7%, 1.5%, 6.5%, 1.4%, 5.0%, 1.9%, 6.1%, 1.9%, 3.7%, 5.4%
+plot: total cpu %
+X range: [27, 56]
+Y range: [4.8092117, 23.36589]
+ *
+
+ *
+ *
+ *
+
+ * *
+ * *
+ *
+ * *
+ *
+ *** * *
+ * * * *
+ ** * *
+ * * **** *
+ ** * *****
+ ***** ** * ** *
+* ** * *** * ** *
+ **** ** ** * * ** ** ***
+ ** *** **************
+
+
+
+
+ GitHub
+
+
+
+ « Previous
+
+
+ Next »
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/features/csv/index.html b/features/csv/index.html
new file mode 100644
index 0000000..4653844
--- /dev/null
+++ b/features/csv/index.html
@@ -0,0 +1,194 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aid csv search
+ aid csv search Sql search over csv
+ -s, --sql <SQL> Sql query e.g SELECT 'first name',age FROM people.csv WHERE age >= 25 AND age < 30 ORDER BY 'age' ASC.
+ -o, --output <OUTPUT> Output file path.
+
+-----input-----
+aid csv search -s "csv search -s "SELECT Platform,COUNT(Name) FROM vgsales.csv GROUP BY Platform ORDER BY COUNT(Name) DESC"
+-----output-----
+Platform,COUNT(Name)
+DS,2163
+PS2,2161
+PS3,1329
+Wii,1325
+X360,1265
+PSP,1213
+PS,1196
+PC,960
+XB,824
+GBA,822
+GC,556
+3DS,509
+PSV,413
+PS4,336
+
+
+
+
+ GitHub
+
+
+
+ « Previous
+
+
+ Next »
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/features/disk/index.html b/features/disk/index.html
new file mode 100644
index 0000000..4136e60
--- /dev/null
+++ b/features/disk/index.html
@@ -0,0 +1,189 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aid disk info
+ aid disk info Show disk information
+ -j, --json Output disk information in JSON format.
+
+-----input-----
+aid disk info -j
+-----output-----
+[
+ {
+ "available_gb": 52.2,
+ "total_gb": 936.2,
+ "percent_free": 5.6,
+ "file_system": "NTFS",
+ "mount_point": "C:\\",
+ "removable": false,
+ "kind": "SSD"
+ }
+]
+
+
+
+
+ GitHub
+
+
+
+ « Previous
+
+
+ Next »
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/features/file/index.html b/features/file/index.html
new file mode 100644
index 0000000..b56ce10
--- /dev/null
+++ b/features/file/index.html
@@ -0,0 +1,221 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aid file info
+ aid file info prints file metadata
+ -f, --file <FILE> file path.
+
+-----input-----
+aid file info -f .\README.md
+-----output-----
+Type: File
+Size: 5582 bytes
+Permissions: Read-only: false
+Modified: 2024-10-21 20:52:25.0 +00:00:00
+Accessed: 2024-10-21 20:52:25.0 +00:00:00
+Created: 2024-10-18 20:45:22.0 +00:00:00
+aid file md5
+ aid file md5 calculates the files Md5 checksum
+ -f, --file <FILE> file path.
+
+-----input-----
+aid file md5 -f .\README.md
+-----output-----
+7d417daec5c2663c7a224297d1fc9d95
+aid file sha1
+ aid file sha1 calculates the files Sha1 checksum
+ -f, --file <FILE> file path.
+
+-----input-----
+aid file sha1 -f .\README.md
+-----output-----
+aaaa9aa5119da904c84eca8b0a1db46947732737
+aid file sha256
+ aid file sha256 calculates the files Sha256 checksum
+ -f, --file <FILE> file path.
+
+-----input-----
+aid file sha256 -f .\README.md
+-----output-----
+06e033f7ca19a5ef5a1be805a41dec6bd5b36cfdd231d6d3959373d6d4fe7ae7
+aid file zip
+ aid file zip zips the files in the source directory
+ -d, --dir <DIRECTORY> file path.
+ -f, --file <FILE> output zip file.
+
+-----input-----
+aid file zip -dir ./src ./src.zip
+-----output-----
+Successfully zipped directory './src'
+
+
+
+
+ GitHub
+
+
+
+ « Previous
+
+
+ Next »
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/features/http/index.html b/features/http/index.html
new file mode 100644
index 0000000..b67b4d3
--- /dev/null
+++ b/features/http/index.html
@@ -0,0 +1,196 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aid http req
+ aid http req Make a HTTP request
+ -m, --method <METHOD> Specify the HTTP method (e.g., GET, POST).
+ -u, --url <URL> Specify the URL for the HTTP request.
+ -c, --config <CONFIG> Path to a configuration file for the request. Specify: method, url, body, headers in json format.
+ -o, --output <OUTPUT> If specified saves http response body to a file at the given path.
+
+-----input-----
+aid http req -m GET -u https://dog-api.kinduff.com/api/facts
+-----output-----
+{
+ "facts": [
+ "The U.S. has the highest dog population in the world. France has the second highest."
+ ],
+ "success": true
+}
+aid http serve
+ aid http serve Start a HTTP server (GET: 0.0.0.0:80 -> 'Hello, World!')
+ -p, --port <PORT> Specify the port for the HTTP server (default is 80). [default: 80]
+
+-----input-----
+aid http serve
+-----output-----
+Server listening on http://0.0.0.0:80
+
+
+
+
+ GitHub
+
+
+
+ « Previous
+
+
+ Next »
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/features/ip/index.html b/features/ip/index.html
new file mode 100644
index 0000000..5db7d21
--- /dev/null
+++ b/features/ip/index.html
@@ -0,0 +1,210 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aid ip local
+ aid ip local Show my local IP address
+ -j, --json Output the local IP address in JSON format.
+
+-----input-----
+aid ip local
+-----output-----
+192.168.0.10
+aid ip public
+ aid ip public Show my public IP address
+ -j, --json Output the local IP address in JSON format.
+
+-----input-----
+aid ip public
+-----output-----
+1.2.3.4
+aid ip scan
+ aid ip scan Scan a specified IP address subnet for active ip addresses
+ -i, --ip <IP> The IP subnet to scan. If not provided, the local subnet will be used. [default: ]
+ -j, --json Output scan results in JSON format.
+
+-----input-----
+aid ip scan
+-----output-----
+1.2.3.0
+1.2.3.2
+1.2.3.4
+aid ip status
+ aid ip status Try to connect to the specified IP address
+ -i, --ip <IP> The IP address to check the status of.
+ -j, --json Output status in JSON format.
+
+-----input-----
+aid ip status -i 1.2.3.2
+-----output-----
+online
+
+
+
+
+ GitHub
+
+
+
+ « Previous
+
+
+ Next »
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/features/json/index.html b/features/json/index.html
new file mode 100644
index 0000000..86ec695
--- /dev/null
+++ b/features/json/index.html
@@ -0,0 +1,189 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aid json jwt-decode
+ aid json jwt-decode <TOKEN> Decode a JWT
+
+-----input-----
+aid json jwt-decode eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiIsImtpZCI6IjM5OWZkM2E5MmI3YTJiNDZjMzQzMDNiOTViOGNhMmMyIn0.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNzI5NTQ2MzUxfQ.BSvGKZUlSPDWtnVjeJG45eUz1JqYZbBYVKPp4EiV23gs8hE92LvnlxnfnZP-QNfb1JTFCPikQKmkAhp5QInTDg
+-----output-----
+{
+ "header": {
+ "alg": "ES256",
+ "kid": "399fd3a92b7a2b46c34303b95b8ca2c2",
+ "typ": "JWT"
+ },
+ "payload": {
+ "iat": 1729546351,
+ "name": "John Doe",
+ "sub": "1234567890"
+ }
+}
+
+
+
+
+ GitHub
+
+
+
+ « Previous
+
+
+ Next »
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/features/math/index.html b/features/math/index.html
new file mode 100644
index 0000000..6929c26
--- /dev/null
+++ b/features/math/index.html
@@ -0,0 +1,210 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aid math eval
+ aid math eval <EXPRESSION> Evaluates a math expression
+
+-----input-----
+aid math eval "sin(pi / 2) * 8 ^ e"
+
+-----output-----
+285.0054081607272
+aid math plot
+ aid math plot <EXPRESSION> Plots a math expression
+ --start <START_X> Start x coord.
+ --end <END_X> End x coord.
+ -s, --step <STEP_X> x step size.
+
+-----input-----
+aid math plot --start -20 --end 20 --step 0.5 "x * sin(1 - x)"
+
+-----output-----
+expression: x * sin(1 - x)
+X range: [-20, 20]
+Y range: [-19.43818, 18.049082]
+ | *
+ * | **
+ *** | **
+ * * | ***
+ * * | ** * **
+ * * ** | *** * *
+ * * *** | * * * *
+ ** * ** * | *** * * * *
+ * * * * *** | * * * * * *
+ * * * ** * ** | ** * * ** * *
+--*---*---*---*--**--******-**---*---*---*--*---*-
+ * * ** * * | *** * * * * **
+ * * * **** | * * * *
+ * * * ** | * * * *
+ ** * * | *** ** *
+ * *** | ***
+ * ** | **
+ * | **
+** |
+** |
+
+
+
+
+ GitHub
+
+
+
+ « Previous
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/features/mem/index.html b/features/mem/index.html
new file mode 100644
index 0000000..a523864
--- /dev/null
+++ b/features/mem/index.html
@@ -0,0 +1,203 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aid mem usage
+ aid mem usage Monitor memory usage
+ -w, --watch Continuously monitor memory usage.
+ -j, --json Output memory usage in JSON format.
+ -p, --plot Plot total % mem usage.
+-----input-----
+aid mem usage -w -p
+-----output-----
+total: 15.4GB, used: 13.3GB (86.6%), free: 2.1GB (13.4%)
+plot: used memory %
+X range: [15, 44]
+Y range: [86.5, 87.1]
+* *
+* **
+*** *
+ ** *
+ * *
+ *
+ *
+ ** ** *
+ * *** **
+ * * ** ***
+ ***** ***** **** *
+ * ** *
+ ** * *
+ ****** *******
+ *
+ *
+ * ********
+ * **
+ * *
+ **
+
+
+
+
+ GitHub
+
+
+
+ « Previous
+
+
+ Next »
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/features/network/index.html b/features/network/index.html
new file mode 100644
index 0000000..52a6a8a
--- /dev/null
+++ b/features/network/index.html
@@ -0,0 +1,195 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aid network info
+ aid network info Show network information
+ -j, --json Output network information in JSON format.
+
+-----input-----
+aid network info -j
+-----output-----
+[
+ {
+ "name": "WiFi",
+ "transmitted": 0.2,
+ "received": 1.5,
+ "mac": "00:00:00:00:00:00"
+ }
+]
+ aid network usage Display network usage
+ -w, --watch Continuously monitor network usage.
+
+-----input-----
+aid network usage -w
+-----output-----
+WiFi: rx 1.05 kB/s, tx 0 B/s
+WiFi-QoS Packet Scheduler-0000: rx 1.05 kB/s, tx 0 B/s
+
+
+
+
+ GitHub
+
+
+
+ « Previous
+
+
+ Next »
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/features/port/index.html b/features/port/index.html
new file mode 100644
index 0000000..008d22a
--- /dev/null
+++ b/features/port/index.html
@@ -0,0 +1,193 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aid port status
+ aid port status Check if the specified port is 'open' or 'closed'.
+ -i, --ip <IP> The IP address to check (optional).
+ -p <PORT> The port number to check the status of.
+ -j, --json Output port status in JSON format.
+
+-----input-----
+aid port status -i 192.168.0.1 -p 80
+-----output-----
+open
+aid port scan
+ aid port scan Scan for open ports on a specified IP address
+ -i, --ip <IP> The IP address to scan (optional).
+ -j, --json Output scan results in JSON format.
+
+-----input-----
+aid port scan -i 192.168.0.1
+-----output-----
+80
+443
+22
+
+
+
+
+ GitHub
+
+
+
+ « Previous
+
+
+ Next »
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/features/process/index.html b/features/process/index.html
new file mode 100644
index 0000000..0486783
--- /dev/null
+++ b/features/process/index.html
@@ -0,0 +1,192 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aid process usage
+ aid process usage Display process information.
+ -f, --filter <FILTER> filter the results by process name regex.
+ -s, --sort <SORT_BY> Sort the results by [cpu, mem, disk]
+ -l, --limit <LIMIT> Limit the number of results to display.
+ -w, --watch Continuously monitor the processes.
+
+-----input-----
+aid process usage -w -s mem -l 10 -f host
+-----output-----
+[pid] [cpu %] [mem] [disk read] [disk write] name
+[5640] 1.20 % 44 MB 0 B/s 0 B/s svchost.exe
+[1568] 0.00 % 42 MB 0 B/s 0 B/s svchost.exe
+[5632] 0.00 % 30 MB 0 B/s 0 B/s svchost.exe
+[9348] 0.00 % 20 MB 0 B/s 0 B/s svchost.exe
+[14736] 0.00 % 20 MB 0 B/s 0 B/s svchost.exe
+[9388] 0.00 % 19 MB 0 B/s 0 B/s svchost.exe
+[9244] 0.00 % 19 MB 0 B/s 0 B/s sihost.exe
+[8396] 0.00 % 19 MB 0 B/s 0 B/s svchost.exe
+[1736] 0.00 % 17 MB 0 B/s 0 B/s svchost.exe
+[37596] 0.00 % 16 MB 0 B/s 0 B/s taskhostw.exe
+
+
+
+
+ GitHub
+
+
+
+ « Previous
+
+
+ Next »
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/features/text/index.html b/features/text/index.html
new file mode 100644
index 0000000..aaf18cf
--- /dev/null
+++ b/features/text/index.html
@@ -0,0 +1,207 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aid text base64-encode
+ aid text base64-encode <INPUT> encodes a base64 string
+
+-----input-----
+aid text base64-encode "Hello, world!"
+-----output-----
+SGVsbG8sIHdvcmxkIQ==
+aid text base64-decode
+ aid text base64-decode <INPUT> decodes a base64 string
+
+-----input-----
+aid text base64-decode SGVsbG8sIHdvcmxkIQ==
+-----output-----
+Hello, world!
+aid text lines
+ aid text lines reads and prints lines from a text file
+ -i, --input <FILE> Input text file to search.
+ -s, --start <START> first line to print
+ -e, --end <END> last line to print
+ -f, --first <HEAD> number of lines from the start of the file to print
+ -l, --last <TAIL> number of lines from the end of the file to print
+
+-----input-----
+aid text lines -i .\README.md -l 10
+-----output-----
+| aid file zip | zips the files in the source directory |
+| aid time unix | Display unix timestamp |
+| aid time dt | Display the datetime |
+| aid bits board | Display the number in bitboard representation |
+| aid bits to-bin | Converts a number to it's binary representation |
+| aid bits to-dec | Converts a number to it's decimal representation |
+| aid bits to-hex | Converts a number to it's hex representation |
+| aid math eval | Evaluates a math expression |
+| aid math plot | Plot a math expression |
+
+
+
+
+ GitHub
+
+
+
+ « Previous
+
+
+ Next »
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/features/time/index.html b/features/time/index.html
new file mode 100644
index 0000000..c476670
--- /dev/null
+++ b/features/time/index.html
@@ -0,0 +1,232 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ aid time chron
+ aid time chron <EXPRESSION> Describes a chron job
+
+-----input-----
+aid time chron 0 30 3 ? * 2#3 *
+-----output-----
+At 3:30 AM, on the third Tuesday of the month
+aid time count-down
+ aid time count-down <MM:SS> Starts a countdown timer
+
+-----input-----
+aid time count-down 10:30
+-----output-----
+Time left: 10 minutes 30 seconds
+aid time unix
+ aid time unix Display unix timestamp
+ -d, --dt Use the specified datetime.
+ -m, --milli Output the timestamp as unix milliseconds.
+
+-----input-----
+aid time unix
+-----output-----
+1729546694
+
+-----input-----
+aid time unix -m
+-----output-----
+1729715103358
+
+-----input-----
+aid time unix -d 'Fri, 14 Jul 2017 02:40:00 +0000'
+-----output-----
+1500000000
+aid time dt
+ aid time dt Display the datetime
+ -l, --local Use the local datetime.
+ -u, --unix Use the specified unix second timestamp.
+ -r, --rfc Output the datetime in Rfc3339 format.
+
+-----input-----
+aid time dt
+-----output-----
+2024-10-21 21:38:34
+
+-----input-----
+aid time dt -l
+-----output-----
+2024-10-21 22:38:14
+
+-----input-----
+aid time dt -u 1729546694
+-----output-----
+2024-10-21 21:38:14
+
+-----input-----
+aid time dt --rfc
+-----output-----
+2024-10-23T20:38:00.086663200+00:00
+
+
+
+
+ GitHub
+
+
+
+ « Previous
+
+
+ Next »
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/img/favicon.ico b/img/favicon.ico
new file mode 100644
index 0000000..e85006a
Binary files /dev/null and b/img/favicon.ico differ
diff --git a/index.html b/index.html
new file mode 100644
index 0000000..20fcafa
--- /dev/null
+++ b/index.html
@@ -0,0 +1,236 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/js/html5shiv.min.js b/js/html5shiv.min.js
new file mode 100644
index 0000000..1a01c94
--- /dev/null
+++ b/js/html5shiv.min.js
@@ -0,0 +1,4 @@
+/**
+* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
+*/
+!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="
+
+
+
+
+
+
+
+
+
+
+
+
+ 
Top level commands:
+ | command | description |
+ |-------------|-----------------------------------------------------------|
+ | aid http | HTTP functions |
+ | aid ip | IP information / scanning |
+ | aid port | Port information / scanning |
+ | aid cpu | System cpu information |
+ | aid mem | System memory information |
+ | aid disk | System disk information |
+ | aid network | System network information |
+ | aid process | Display process information |
+ | aid json | JSON parsing / extraction functions |
+ | aid csv | CSV search / transformation functions |
+ | aid text | Text manipulation functions |
+ | aid file | File info functions |
+ | aid time | Time related functions |
+ | aid bits | Bit manipulation functions |
+ | aid math | Math functions |
+ | aid help | Print this message or the help of the given subcommand(s) |
+All commands:
+| version | command | description |
+|-----------|------------------------|------------------------------------------------------------|
+| [u] 0.1.3 | aid http req | Make a HTTP request |
+| [u] 0.1.3 | aid http serve | Start a dummy HTTP server |
+| [u] 0.1.3 | aid ip local | Show my local IP address |
+| [u] 0.1.3 | aid ip public | Show my public IP address |
+| [u] 0.1.3 | aid ip scan | Scan a specified IP address subnet for active ip addresses |
+| [u] 0.1.3 | aid ip status | Try to connect to the specified IP address |
+| [u] 0.1.3 | aid port status | Check if the specified port is 'open' or 'closed'. |
+| [u] 0.1.3 | aid port scan | Scan for open ports on a specified IP address |
+| [u] 0.1.3 | aid cpu info | Show CPU information |
+| [u] 0.1.6 | aid cpu usage | Monitor CPU usage |
+| [u] 0.1.6 | aid mem usage | Monitor memory usage |
+| [u] 0.1.3 | aid disk info | Show disk information |
+| [u] 0.1.3 | aid network info | Show network information |
+| [u] 0.1.3 | aid network usage | Display network usage |
+| [a] 0.1.7 | aid process usage | Display process usage |
+| [u] 0.1.3 | aid json extract | Extract a property from JSON data |
+| [u] 0.1.3 | aid json jwt-decode | Decode a JWT |
+| [u] 0.1.3 | aid csv search | Sql search over csv |
+| [u] 0.1.3 | aid text base64-encode | encodes a base64 string |
+| [u] 0.1.3 | aid text base64-decode | decodes a base64 string |
+| [u] 0.1.3 | aid text lines | reads and prints lines from a text file |
+| [u] 0.1.3 | aid file info | prints file metadata |
+| [u] 0.1.3 | aid file md5 | calculates the files Md5 checksum |
+| [u] 0.1.3 | aid file sha1 | calculates the files Sha1 checksum |
+| [u] 0.1.3 | aid file sha256 | calculates the files Sha256 checksum |
+| [a] 0.1.4 | aid file zip | zips the files in the source directory |
+| [u] 0.1.9 | aid time unix | Display unix timestamp |
+| [u] 0.1.9 | aid time dt | Display the datetime |
+| [a] 0.1.9 | aid time chron | Describes a chron job |
+| [a] 0.1.9 | aid time count-down | Starts a countdown timer |
+| [a] 0.1.8 | aid bits eval | Bitwise expression evaluation / conversion / information |
+| [u] 0.1.3 | aid math eval | Evaluates a math expression |
+| [u] 0.1.3 | aid math plot | Plot a math expression |
+
+[a] added in version x.x.x
+[u] lasted updated in version x.x.x
+[p] last patched in version x.x.x
+[d] deprecated in version x.x.x
+Support 🛟
+Need help? Ping me on linkedin and I'd be more then happy to jump on a call to debug, help configure or answer any questions.
+ +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Installation
+Manual installation is simple, just download the release and add it to your PATH environment variable, if you'd like an even easier way i've added scripts to do it for you.
+Linux / Mac
+wget https://raw.githubusercontent.com/Timmoth/aid-cli/refs/heads/main/install.sh
+chmod +x install.sh
+sudo ./install.sh
+Windows (powershell)
+Invoke-WebRequest -Uri https://raw.githubusercontent.com/Timmoth/aid-cli/refs/heads/main/install.ps1 -OutFile install.ps1
+Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass -Force
+.\install.ps1
+Releases
+ +Build
+If you'd like to build the latest version from source: +
//Install rust https://www.rust-lang.org/tools/install
+git clone https://github.com/Timmoth/aid-cli
+cd aid-cli
+cargo build --release
+.\target\release\aid.exe
+
+
+
+
+ GitHub
+
+
+
+ « Previous
+
+
+ Next »
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/search.html b/search.html
new file mode 100644
index 0000000..cf2933e
--- /dev/null
+++ b/search.html
@@ -0,0 +1,162 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Search Results
+ + + +
+ Searching...
+
+
+
+
+
+
+
+ GitHub
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/search/lunr.js b/search/lunr.js
new file mode 100644
index 0000000..aca0a16
--- /dev/null
+++ b/search/lunr.js
@@ -0,0 +1,3475 @@
+/**
+ * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9
+ * Copyright (C) 2020 Oliver Nightingale
+ * @license MIT
+ */
+
+;(function(){
+
+/**
+ * A convenience function for configuring and constructing
+ * a new lunr Index.
+ *
+ * A lunr.Builder instance is created and the pipeline setup
+ * with a trimmer, stop word filter and stemmer.
+ *
+ * This builder object is yielded to the configuration function
+ * that is passed as a parameter, allowing the list of fields
+ * and other builder parameters to be customised.
+ *
+ * All documents _must_ be added within the passed config function.
+ *
+ * @example
+ * var idx = lunr(function () {
+ * this.field('title')
+ * this.field('body')
+ * this.ref('id')
+ *
+ * documents.forEach(function (doc) {
+ * this.add(doc)
+ * }, this)
+ * })
+ *
+ * @see {@link lunr.Builder}
+ * @see {@link lunr.Pipeline}
+ * @see {@link lunr.trimmer}
+ * @see {@link lunr.stopWordFilter}
+ * @see {@link lunr.stemmer}
+ * @namespace {function} lunr
+ */
+var lunr = function (config) {
+ var builder = new lunr.Builder
+
+ builder.pipeline.add(
+ lunr.trimmer,
+ lunr.stopWordFilter,
+ lunr.stemmer
+ )
+
+ builder.searchPipeline.add(
+ lunr.stemmer
+ )
+
+ config.call(builder, builder)
+ return builder.build()
+}
+
+lunr.version = "2.3.9"
+/*!
+ * lunr.utils
+ * Copyright (C) 2020 Oliver Nightingale
+ */
+
+/**
+ * A namespace containing utils for the rest of the lunr library
+ * @namespace lunr.utils
+ */
+lunr.utils = {}
+
+/**
+ * Print a warning message to the console.
+ *
+ * @param {String} message The message to be printed.
+ * @memberOf lunr.utils
+ * @function
+ */
+lunr.utils.warn = (function (global) {
+ /* eslint-disable no-console */
+ return function (message) {
+ if (global.console && console.warn) {
+ console.warn(message)
+ }
+ }
+ /* eslint-enable no-console */
+})(this)
+
+/**
+ * Convert an object to a string.
+ *
+ * In the case of `null` and `undefined` the function returns
+ * the empty string, in all other cases the result of calling
+ * `toString` on the passed object is returned.
+ *
+ * @param {Any} obj The object to convert to a string.
+ * @return {String} string representation of the passed object.
+ * @memberOf lunr.utils
+ */
+lunr.utils.asString = function (obj) {
+ if (obj === void 0 || obj === null) {
+ return ""
+ } else {
+ return obj.toString()
+ }
+}
+
+/**
+ * Clones an object.
+ *
+ * Will create a copy of an existing object such that any mutations
+ * on the copy cannot affect the original.
+ *
+ * Only shallow objects are supported, passing a nested object to this
+ * function will cause a TypeError.
+ *
+ * Objects with primitives, and arrays of primitives are supported.
+ *
+ * @param {Object} obj The object to clone.
+ * @return {Object} a clone of the passed object.
+ * @throws {TypeError} when a nested object is passed.
+ * @memberOf Utils
+ */
+lunr.utils.clone = function (obj) {
+ if (obj === null || obj === undefined) {
+ return obj
+ }
+
+ var clone = Object.create(null),
+ keys = Object.keys(obj)
+
+ for (var i = 0; i < keys.length; i++) {
+ var key = keys[i],
+ val = obj[key]
+
+ if (Array.isArray(val)) {
+ clone[key] = val.slice()
+ continue
+ }
+
+ if (typeof val === 'string' ||
+ typeof val === 'number' ||
+ typeof val === 'boolean') {
+ clone[key] = val
+ continue
+ }
+
+ throw new TypeError("clone is not deep and does not support nested objects")
+ }
+
+ return clone
+}
+lunr.FieldRef = function (docRef, fieldName, stringValue) {
+ this.docRef = docRef
+ this.fieldName = fieldName
+ this._stringValue = stringValue
+}
+
+lunr.FieldRef.joiner = "/"
+
+lunr.FieldRef.fromString = function (s) {
+ var n = s.indexOf(lunr.FieldRef.joiner)
+
+ if (n === -1) {
+ throw "malformed field ref string"
+ }
+
+ var fieldRef = s.slice(0, n),
+ docRef = s.slice(n + 1)
+
+ return new lunr.FieldRef (docRef, fieldRef, s)
+}
+
+lunr.FieldRef.prototype.toString = function () {
+ if (this._stringValue == undefined) {
+ this._stringValue = this.fieldName + lunr.FieldRef.joiner + this.docRef
+ }
+
+ return this._stringValue
+}
+/*!
+ * lunr.Set
+ * Copyright (C) 2020 Oliver Nightingale
+ */
+
+/**
+ * A lunr set.
+ *
+ * @constructor
+ */
+lunr.Set = function (elements) {
+ this.elements = Object.create(null)
+
+ if (elements) {
+ this.length = elements.length
+
+ for (var i = 0; i < this.length; i++) {
+ this.elements[elements[i]] = true
+ }
+ } else {
+ this.length = 0
+ }
+}
+
+/**
+ * A complete set that contains all elements.
+ *
+ * @static
+ * @readonly
+ * @type {lunr.Set}
+ */
+lunr.Set.complete = {
+ intersect: function (other) {
+ return other
+ },
+
+ union: function () {
+ return this
+ },
+
+ contains: function () {
+ return true
+ }
+}
+
+/**
+ * An empty set that contains no elements.
+ *
+ * @static
+ * @readonly
+ * @type {lunr.Set}
+ */
+lunr.Set.empty = {
+ intersect: function () {
+ return this
+ },
+
+ union: function (other) {
+ return other
+ },
+
+ contains: function () {
+ return false
+ }
+}
+
+/**
+ * Returns true if this set contains the specified object.
+ *
+ * @param {object} object - Object whose presence in this set is to be tested.
+ * @returns {boolean} - True if this set contains the specified object.
+ */
+lunr.Set.prototype.contains = function (object) {
+ return !!this.elements[object]
+}
+
+/**
+ * Returns a new set containing only the elements that are present in both
+ * this set and the specified set.
+ *
+ * @param {lunr.Set} other - set to intersect with this set.
+ * @returns {lunr.Set} a new set that is the intersection of this and the specified set.
+ */
+
+lunr.Set.prototype.intersect = function (other) {
+ var a, b, elements, intersection = []
+
+ if (other === lunr.Set.complete) {
+ return this
+ }
+
+ if (other === lunr.Set.empty) {
+ return other
+ }
+
+ if (this.length < other.length) {
+ a = this
+ b = other
+ } else {
+ a = other
+ b = this
+ }
+
+ elements = Object.keys(a.elements)
+
+ for (var i = 0; i < elements.length; i++) {
+ var element = elements[i]
+ if (element in b.elements) {
+ intersection.push(element)
+ }
+ }
+
+ return new lunr.Set (intersection)
+}
+
+/**
+ * Returns a new set combining the elements of this and the specified set.
+ *
+ * @param {lunr.Set} other - set to union with this set.
+ * @return {lunr.Set} a new set that is the union of this and the specified set.
+ */
+
+lunr.Set.prototype.union = function (other) {
+ if (other === lunr.Set.complete) {
+ return lunr.Set.complete
+ }
+
+ if (other === lunr.Set.empty) {
+ return this
+ }
+
+ return new lunr.Set(Object.keys(this.elements).concat(Object.keys(other.elements)))
+}
+/**
+ * A function to calculate the inverse document frequency for
+ * a posting. This is shared between the builder and the index
+ *
+ * @private
+ * @param {object} posting - The posting for a given term
+ * @param {number} documentCount - The total number of documents.
+ */
+lunr.idf = function (posting, documentCount) {
+ var documentsWithTerm = 0
+
+ for (var fieldName in posting) {
+ if (fieldName == '_index') continue // Ignore the term index, its not a field
+ documentsWithTerm += Object.keys(posting[fieldName]).length
+ }
+
+ var x = (documentCount - documentsWithTerm + 0.5) / (documentsWithTerm + 0.5)
+
+ return Math.log(1 + Math.abs(x))
+}
+
+/**
+ * A token wraps a string representation of a token
+ * as it is passed through the text processing pipeline.
+ *
+ * @constructor
+ * @param {string} [str=''] - The string token being wrapped.
+ * @param {object} [metadata={}] - Metadata associated with this token.
+ */
+lunr.Token = function (str, metadata) {
+ this.str = str || ""
+ this.metadata = metadata || {}
+}
+
+/**
+ * Returns the token string that is being wrapped by this object.
+ *
+ * @returns {string}
+ */
+lunr.Token.prototype.toString = function () {
+ return this.str
+}
+
+/**
+ * A token update function is used when updating or optionally
+ * when cloning a token.
+ *
+ * @callback lunr.Token~updateFunction
+ * @param {string} str - The string representation of the token.
+ * @param {Object} metadata - All metadata associated with this token.
+ */
+
+/**
+ * Applies the given function to the wrapped string token.
+ *
+ * @example
+ * token.update(function (str, metadata) {
+ * return str.toUpperCase()
+ * })
+ *
+ * @param {lunr.Token~updateFunction} fn - A function to apply to the token string.
+ * @returns {lunr.Token}
+ */
+lunr.Token.prototype.update = function (fn) {
+ this.str = fn(this.str, this.metadata)
+ return this
+}
+
+/**
+ * Creates a clone of this token. Optionally a function can be
+ * applied to the cloned token.
+ *
+ * @param {lunr.Token~updateFunction} [fn] - An optional function to apply to the cloned token.
+ * @returns {lunr.Token}
+ */
+lunr.Token.prototype.clone = function (fn) {
+ fn = fn || function (s) { return s }
+ return new lunr.Token (fn(this.str, this.metadata), this.metadata)
+}
+/*!
+ * lunr.tokenizer
+ * Copyright (C) 2020 Oliver Nightingale
+ */
+
+/**
+ * A function for splitting a string into tokens ready to be inserted into
+ * the search index. Uses `lunr.tokenizer.separator` to split strings, change
+ * the value of this property to change how strings are split into tokens.
+ *
+ * This tokenizer will convert its parameter to a string by calling `toString` and
+ * then will split this string on the character in `lunr.tokenizer.separator`.
+ * Arrays will have their elements converted to strings and wrapped in a lunr.Token.
+ *
+ * Optional metadata can be passed to the tokenizer, this metadata will be cloned and
+ * added as metadata to every token that is created from the object to be tokenized.
+ *
+ * @static
+ * @param {?(string|object|object[])} obj - The object to convert into tokens
+ * @param {?object} metadata - Optional metadata to associate with every token
+ * @returns {lunr.Token[]}
+ * @see {@link lunr.Pipeline}
+ */
+lunr.tokenizer = function (obj, metadata) {
+ if (obj == null || obj == undefined) {
+ return []
+ }
+
+ if (Array.isArray(obj)) {
+ return obj.map(function (t) {
+ return new lunr.Token(
+ lunr.utils.asString(t).toLowerCase(),
+ lunr.utils.clone(metadata)
+ )
+ })
+ }
+
+ var str = obj.toString().toLowerCase(),
+ len = str.length,
+ tokens = []
+
+ for (var sliceEnd = 0, sliceStart = 0; sliceEnd <= len; sliceEnd++) {
+ var char = str.charAt(sliceEnd),
+ sliceLength = sliceEnd - sliceStart
+
+ if ((char.match(lunr.tokenizer.separator) || sliceEnd == len)) {
+
+ if (sliceLength > 0) {
+ var tokenMetadata = lunr.utils.clone(metadata) || {}
+ tokenMetadata["position"] = [sliceStart, sliceLength]
+ tokenMetadata["index"] = tokens.length
+
+ tokens.push(
+ new lunr.Token (
+ str.slice(sliceStart, sliceEnd),
+ tokenMetadata
+ )
+ )
+ }
+
+ sliceStart = sliceEnd + 1
+ }
+
+ }
+
+ return tokens
+}
+
+/**
+ * The separator used to split a string into tokens. Override this property to change the behaviour of
+ * `lunr.tokenizer` behaviour when tokenizing strings. By default this splits on whitespace and hyphens.
+ *
+ * @static
+ * @see lunr.tokenizer
+ */
+lunr.tokenizer.separator = /[\s\-]+/
+/*!
+ * lunr.Pipeline
+ * Copyright (C) 2020 Oliver Nightingale
+ */
+
+/**
+ * lunr.Pipelines maintain an ordered list of functions to be applied to all
+ * tokens in documents entering the search index and queries being ran against
+ * the index.
+ *
+ * An instance of lunr.Index created with the lunr shortcut will contain a
+ * pipeline with a stop word filter and an English language stemmer. Extra
+ * functions can be added before or after either of these functions or these
+ * default functions can be removed.
+ *
+ * When run the pipeline will call each function in turn, passing a token, the
+ * index of that token in the original list of all tokens and finally a list of
+ * all the original tokens.
+ *
+ * The output of functions in the pipeline will be passed to the next function
+ * in the pipeline. To exclude a token from entering the index the function
+ * should return undefined, the rest of the pipeline will not be called with
+ * this token.
+ *
+ * For serialisation of pipelines to work, all functions used in an instance of
+ * a pipeline should be registered with lunr.Pipeline. Registered functions can
+ * then be loaded. If trying to load a serialised pipeline that uses functions
+ * that are not registered an error will be thrown.
+ *
+ * If not planning on serialising the pipeline then registering pipeline functions
+ * is not necessary.
+ *
+ * @constructor
+ */
+lunr.Pipeline = function () {
+ this._stack = []
+}
+
+lunr.Pipeline.registeredFunctions = Object.create(null)
+
+/**
+ * A pipeline function maps lunr.Token to lunr.Token. A lunr.Token contains the token
+ * string as well as all known metadata. A pipeline function can mutate the token string
+ * or mutate (or add) metadata for a given token.
+ *
+ * A pipeline function can indicate that the passed token should be discarded by returning
+ * null, undefined or an empty string. This token will not be passed to any downstream pipeline
+ * functions and will not be added to the index.
+ *
+ * Multiple tokens can be returned by returning an array of tokens. Each token will be passed
+ * to any downstream pipeline functions and all will returned tokens will be added to the index.
+ *
+ * Any number of pipeline functions may be chained together using a lunr.Pipeline.
+ *
+ * @interface lunr.PipelineFunction
+ * @param {lunr.Token} token - A token from the document being processed.
+ * @param {number} i - The index of this token in the complete list of tokens for this document/field.
+ * @param {lunr.Token[]} tokens - All tokens for this document/field.
+ * @returns {(?lunr.Token|lunr.Token[])}
+ */
+
+/**
+ * Register a function with the pipeline.
+ *
+ * Functions that are used in the pipeline should be registered if the pipeline
+ * needs to be serialised, or a serialised pipeline needs to be loaded.
+ *
+ * Registering a function does not add it to a pipeline, functions must still be
+ * added to instances of the pipeline for them to be used when running a pipeline.
+ *
+ * @param {lunr.PipelineFunction} fn - The function to check for.
+ * @param {String} label - The label to register this function with
+ */
+lunr.Pipeline.registerFunction = function (fn, label) {
+ if (label in this.registeredFunctions) {
+ lunr.utils.warn('Overwriting existing registered function: ' + label)
+ }
+
+ fn.label = label
+ lunr.Pipeline.registeredFunctions[fn.label] = fn
+}
+
+/**
+ * Warns if the function is not registered as a Pipeline function.
+ *
+ * @param {lunr.PipelineFunction} fn - The function to check for.
+ * @private
+ */
+lunr.Pipeline.warnIfFunctionNotRegistered = function (fn) {
+ var isRegistered = fn.label && (fn.label in this.registeredFunctions)
+
+ if (!isRegistered) {
+ lunr.utils.warn('Function is not registered with pipeline. This may cause problems when serialising the index.\n', fn)
+ }
+}
+
+/**
+ * Loads a previously serialised pipeline.
+ *
+ * All functions to be loaded must already be registered with lunr.Pipeline.
+ * If any function from the serialised data has not been registered then an
+ * error will be thrown.
+ *
+ * @param {Object} serialised - The serialised pipeline to load.
+ * @returns {lunr.Pipeline}
+ */
+lunr.Pipeline.load = function (serialised) {
+ var pipeline = new lunr.Pipeline
+
+ serialised.forEach(function (fnName) {
+ var fn = lunr.Pipeline.registeredFunctions[fnName]
+
+ if (fn) {
+ pipeline.add(fn)
+ } else {
+ throw new Error('Cannot load unregistered function: ' + fnName)
+ }
+ })
+
+ return pipeline
+}
+
+/**
+ * Adds new functions to the end of the pipeline.
+ *
+ * Logs a warning if the function has not been registered.
+ *
+ * @param {lunr.PipelineFunction[]} functions - Any number of functions to add to the pipeline.
+ */
+lunr.Pipeline.prototype.add = function () {
+ var fns = Array.prototype.slice.call(arguments)
+
+ fns.forEach(function (fn) {
+ lunr.Pipeline.warnIfFunctionNotRegistered(fn)
+ this._stack.push(fn)
+ }, this)
+}
+
+/**
+ * Adds a single function after a function that already exists in the
+ * pipeline.
+ *
+ * Logs a warning if the function has not been registered.
+ *
+ * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.
+ * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.
+ */
+lunr.Pipeline.prototype.after = function (existingFn, newFn) {
+ lunr.Pipeline.warnIfFunctionNotRegistered(newFn)
+
+ var pos = this._stack.indexOf(existingFn)
+ if (pos == -1) {
+ throw new Error('Cannot find existingFn')
+ }
+
+ pos = pos + 1
+ this._stack.splice(pos, 0, newFn)
+}
+
+/**
+ * Adds a single function before a function that already exists in the
+ * pipeline.
+ *
+ * Logs a warning if the function has not been registered.
+ *
+ * @param {lunr.PipelineFunction} existingFn - A function that already exists in the pipeline.
+ * @param {lunr.PipelineFunction} newFn - The new function to add to the pipeline.
+ */
+lunr.Pipeline.prototype.before = function (existingFn, newFn) {
+ lunr.Pipeline.warnIfFunctionNotRegistered(newFn)
+
+ var pos = this._stack.indexOf(existingFn)
+ if (pos == -1) {
+ throw new Error('Cannot find existingFn')
+ }
+
+ this._stack.splice(pos, 0, newFn)
+}
+
+/**
+ * Removes a function from the pipeline.
+ *
+ * @param {lunr.PipelineFunction} fn The function to remove from the pipeline.
+ */
+lunr.Pipeline.prototype.remove = function (fn) {
+ var pos = this._stack.indexOf(fn)
+ if (pos == -1) {
+ return
+ }
+
+ this._stack.splice(pos, 1)
+}
+
+/**
+ * Runs the current list of functions that make up the pipeline against the
+ * passed tokens.
+ *
+ * @param {Array} tokens The tokens to run through the pipeline.
+ * @returns {Array}
+ */
+lunr.Pipeline.prototype.run = function (tokens) {
+ var stackLength = this._stack.length
+
+ for (var i = 0; i < stackLength; i++) {
+ var fn = this._stack[i]
+ var memo = []
+
+ for (var j = 0; j < tokens.length; j++) {
+ var result = fn(tokens[j], j, tokens)
+
+ if (result === null || result === void 0 || result === '') continue
+
+ if (Array.isArray(result)) {
+ for (var k = 0; k < result.length; k++) {
+ memo.push(result[k])
+ }
+ } else {
+ memo.push(result)
+ }
+ }
+
+ tokens = memo
+ }
+
+ return tokens
+}
+
+/**
+ * Convenience method for passing a string through a pipeline and getting
+ * strings out. This method takes care of wrapping the passed string in a
+ * token and mapping the resulting tokens back to strings.
+ *
+ * @param {string} str - The string to pass through the pipeline.
+ * @param {?object} metadata - Optional metadata to associate with the token
+ * passed to the pipeline.
+ * @returns {string[]}
+ */
+lunr.Pipeline.prototype.runString = function (str, metadata) {
+ var token = new lunr.Token (str, metadata)
+
+ return this.run([token]).map(function (t) {
+ return t.toString()
+ })
+}
+
+/**
+ * Resets the pipeline by removing any existing processors.
+ *
+ */
+lunr.Pipeline.prototype.reset = function () {
+ this._stack = []
+}
+
+/**
+ * Returns a representation of the pipeline ready for serialisation.
+ *
+ * Logs a warning if the function has not been registered.
+ *
+ * @returns {Array}
+ */
+lunr.Pipeline.prototype.toJSON = function () {
+ return this._stack.map(function (fn) {
+ lunr.Pipeline.warnIfFunctionNotRegistered(fn)
+
+ return fn.label
+ })
+}
+/*!
+ * lunr.Vector
+ * Copyright (C) 2020 Oliver Nightingale
+ */
+
+/**
+ * A vector is used to construct the vector space of documents and queries. These
+ * vectors support operations to determine the similarity between two documents or
+ * a document and a query.
+ *
+ * Normally no parameters are required for initializing a vector, but in the case of
+ * loading a previously dumped vector the raw elements can be provided to the constructor.
+ *
+ * For performance reasons vectors are implemented with a flat array, where an elements
+ * index is immediately followed by its value. E.g. [index, value, index, value]. This
+ * allows the underlying array to be as sparse as possible and still offer decent
+ * performance when being used for vector calculations.
+ *
+ * @constructor
+ * @param {Number[]} [elements] - The flat list of element index and element value pairs.
+ */
+lunr.Vector = function (elements) {
+ this._magnitude = 0
+ this.elements = elements || []
+}
+
+
+/**
+ * Calculates the position within the vector to insert a given index.
+ *
+ * This is used internally by insert and upsert. If there are duplicate indexes then
+ * the position is returned as if the value for that index were to be updated, but it
+ * is the callers responsibility to check whether there is a duplicate at that index
+ *
+ * @param {Number} insertIdx - The index at which the element should be inserted.
+ * @returns {Number}
+ */
+lunr.Vector.prototype.positionForIndex = function (index) {
+ // For an empty vector the tuple can be inserted at the beginning
+ if (this.elements.length == 0) {
+ return 0
+ }
+
+ var start = 0,
+ end = this.elements.length / 2,
+ sliceLength = end - start,
+ pivotPoint = Math.floor(sliceLength / 2),
+ pivotIndex = this.elements[pivotPoint * 2]
+
+ while (sliceLength > 1) {
+ if (pivotIndex < index) {
+ start = pivotPoint
+ }
+
+ if (pivotIndex > index) {
+ end = pivotPoint
+ }
+
+ if (pivotIndex == index) {
+ break
+ }
+
+ sliceLength = end - start
+ pivotPoint = start + Math.floor(sliceLength / 2)
+ pivotIndex = this.elements[pivotPoint * 2]
+ }
+
+ if (pivotIndex == index) {
+ return pivotPoint * 2
+ }
+
+ if (pivotIndex > index) {
+ return pivotPoint * 2
+ }
+
+ if (pivotIndex < index) {
+ return (pivotPoint + 1) * 2
+ }
+}
+
+/**
+ * Inserts an element at an index within the vector.
+ *
+ * Does not allow duplicates, will throw an error if there is already an entry
+ * for this index.
+ *
+ * @param {Number} insertIdx - The index at which the element should be inserted.
+ * @param {Number} val - The value to be inserted into the vector.
+ */
+lunr.Vector.prototype.insert = function (insertIdx, val) {
+ this.upsert(insertIdx, val, function () {
+ throw "duplicate index"
+ })
+}
+
+/**
+ * Inserts or updates an existing index within the vector.
+ *
+ * @param {Number} insertIdx - The index at which the element should be inserted.
+ * @param {Number} val - The value to be inserted into the vector.
+ * @param {function} fn - A function that is called for updates, the existing value and the
+ * requested value are passed as arguments
+ */
+lunr.Vector.prototype.upsert = function (insertIdx, val, fn) {
+ this._magnitude = 0
+ var position = this.positionForIndex(insertIdx)
+
+ if (this.elements[position] == insertIdx) {
+ this.elements[position + 1] = fn(this.elements[position + 1], val)
+ } else {
+ this.elements.splice(position, 0, insertIdx, val)
+ }
+}
+
+/**
+ * Calculates the magnitude of this vector.
+ *
+ * @returns {Number}
+ */
+lunr.Vector.prototype.magnitude = function () {
+ if (this._magnitude) return this._magnitude
+
+ var sumOfSquares = 0,
+ elementsLength = this.elements.length
+
+ for (var i = 1; i < elementsLength; i += 2) {
+ var val = this.elements[i]
+ sumOfSquares += val * val
+ }
+
+ return this._magnitude = Math.sqrt(sumOfSquares)
+}
+
+/**
+ * Calculates the dot product of this vector and another vector.
+ *
+ * @param {lunr.Vector} otherVector - The vector to compute the dot product with.
+ * @returns {Number}
+ */
+lunr.Vector.prototype.dot = function (otherVector) {
+ var dotProduct = 0,
+ a = this.elements, b = otherVector.elements,
+ aLen = a.length, bLen = b.length,
+ aVal = 0, bVal = 0,
+ i = 0, j = 0
+
+ while (i < aLen && j < bLen) {
+ aVal = a[i], bVal = b[j]
+ if (aVal < bVal) {
+ i += 2
+ } else if (aVal > bVal) {
+ j += 2
+ } else if (aVal == bVal) {
+ dotProduct += a[i + 1] * b[j + 1]
+ i += 2
+ j += 2
+ }
+ }
+
+ return dotProduct
+}
+
+/**
+ * Calculates the similarity between this vector and another vector.
+ *
+ * @param {lunr.Vector} otherVector - The other vector to calculate the
+ * similarity with.
+ * @returns {Number}
+ */
+lunr.Vector.prototype.similarity = function (otherVector) {
+ return this.dot(otherVector) / this.magnitude() || 0
+}
+
+/**
+ * Converts the vector to an array of the elements within the vector.
+ *
+ * @returns {Number[]}
+ */
+lunr.Vector.prototype.toArray = function () {
+ var output = new Array (this.elements.length / 2)
+
+ for (var i = 1, j = 0; i < this.elements.length; i += 2, j++) {
+ output[j] = this.elements[i]
+ }
+
+ return output
+}
+
+/**
+ * A JSON serializable representation of the vector.
+ *
+ * @returns {Number[]}
+ */
+lunr.Vector.prototype.toJSON = function () {
+ return this.elements
+}
+/* eslint-disable */
+/*!
+ * lunr.stemmer
+ * Copyright (C) 2020 Oliver Nightingale
+ * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt
+ */
+
+/**
+ * lunr.stemmer is an english language stemmer, this is a JavaScript
+ * implementation of the PorterStemmer taken from http://tartarus.org/~martin
+ *
+ * @static
+ * @implements {lunr.PipelineFunction}
+ * @param {lunr.Token} token - The string to stem
+ * @returns {lunr.Token}
+ * @see {@link lunr.Pipeline}
+ * @function
+ */
+lunr.stemmer = (function(){
+ var step2list = {
+ "ational" : "ate",
+ "tional" : "tion",
+ "enci" : "ence",
+ "anci" : "ance",
+ "izer" : "ize",
+ "bli" : "ble",
+ "alli" : "al",
+ "entli" : "ent",
+ "eli" : "e",
+ "ousli" : "ous",
+ "ization" : "ize",
+ "ation" : "ate",
+ "ator" : "ate",
+ "alism" : "al",
+ "iveness" : "ive",
+ "fulness" : "ful",
+ "ousness" : "ous",
+ "aliti" : "al",
+ "iviti" : "ive",
+ "biliti" : "ble",
+ "logi" : "log"
+ },
+
+ step3list = {
+ "icate" : "ic",
+ "ative" : "",
+ "alize" : "al",
+ "iciti" : "ic",
+ "ical" : "ic",
+ "ful" : "",
+ "ness" : ""
+ },
+
+ c = "[^aeiou]", // consonant
+ v = "[aeiouy]", // vowel
+ C = c + "[^aeiouy]*", // consonant sequence
+ V = v + "[aeiou]*", // vowel sequence
+
+ mgr0 = "^(" + C + ")?" + V + C, // [C]VC... is m>0
+ meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$", // [C]VC[V] is m=1
+ mgr1 = "^(" + C + ")?" + V + C + V + C, // [C]VCVC... is m>1
+ s_v = "^(" + C + ")?" + v; // vowel in stem
+
+ var re_mgr0 = new RegExp(mgr0);
+ var re_mgr1 = new RegExp(mgr1);
+ var re_meq1 = new RegExp(meq1);
+ var re_s_v = new RegExp(s_v);
+
+ var re_1a = /^(.+?)(ss|i)es$/;
+ var re2_1a = /^(.+?)([^s])s$/;
+ var re_1b = /^(.+?)eed$/;
+ var re2_1b = /^(.+?)(ed|ing)$/;
+ var re_1b_2 = /.$/;
+ var re2_1b_2 = /(at|bl|iz)$/;
+ var re3_1b_2 = new RegExp("([^aeiouylsz])\\1$");
+ var re4_1b_2 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+
+ var re_1c = /^(.+?[^aeiou])y$/;
+ var re_2 = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
+
+ var re_3 = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
+
+ var re_4 = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
+ var re2_4 = /^(.+?)(s|t)(ion)$/;
+
+ var re_5 = /^(.+?)e$/;
+ var re_5_1 = /ll$/;
+ var re3_5 = new RegExp("^" + C + v + "[^aeiouwxy]$");
+
+ var porterStemmer = function porterStemmer(w) {
+ var stem,
+ suffix,
+ firstch,
+ re,
+ re2,
+ re3,
+ re4;
+
+ if (w.length < 3) { return w; }
+
+ firstch = w.substr(0,1);
+ if (firstch == "y") {
+ w = firstch.toUpperCase() + w.substr(1);
+ }
+
+ // Step 1a
+ re = re_1a
+ re2 = re2_1a;
+
+ if (re.test(w)) { w = w.replace(re,"$1$2"); }
+ else if (re2.test(w)) { w = w.replace(re2,"$1$2"); }
+
+ // Step 1b
+ re = re_1b;
+ re2 = re2_1b;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ re = re_mgr0;
+ if (re.test(fp[1])) {
+ re = re_1b_2;
+ w = w.replace(re,"");
+ }
+ } else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1];
+ re2 = re_s_v;
+ if (re2.test(stem)) {
+ w = stem;
+ re2 = re2_1b_2;
+ re3 = re3_1b_2;
+ re4 = re4_1b_2;
+ if (re2.test(w)) { w = w + "e"; }
+ else if (re3.test(w)) { re = re_1b_2; w = w.replace(re,""); }
+ else if (re4.test(w)) { w = w + "e"; }
+ }
+ }
+
+ // Step 1c - replace suffix y or Y by i if preceded by a non-vowel which is not the first letter of the word (so cry -> cri, by -> by, say -> say)
+ re = re_1c;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ w = stem + "i";
+ }
+
+ // Step 2
+ re = re_2;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = re_mgr0;
+ if (re.test(stem)) {
+ w = stem + step2list[suffix];
+ }
+ }
+
+ // Step 3
+ re = re_3;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ suffix = fp[2];
+ re = re_mgr0;
+ if (re.test(stem)) {
+ w = stem + step3list[suffix];
+ }
+ }
+
+ // Step 4
+ re = re_4;
+ re2 = re2_4;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = re_mgr1;
+ if (re.test(stem)) {
+ w = stem;
+ }
+ } else if (re2.test(w)) {
+ var fp = re2.exec(w);
+ stem = fp[1] + fp[2];
+ re2 = re_mgr1;
+ if (re2.test(stem)) {
+ w = stem;
+ }
+ }
+
+ // Step 5
+ re = re_5;
+ if (re.test(w)) {
+ var fp = re.exec(w);
+ stem = fp[1];
+ re = re_mgr1;
+ re2 = re_meq1;
+ re3 = re3_5;
+ if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) {
+ w = stem;
+ }
+ }
+
+ re = re_5_1;
+ re2 = re_mgr1;
+ if (re.test(w) && re2.test(w)) {
+ re = re_1b_2;
+ w = w.replace(re,"");
+ }
+
+ // and turn initial Y back to y
+
+ if (firstch == "y") {
+ w = firstch.toLowerCase() + w.substr(1);
+ }
+
+ return w;
+ };
+
+ return function (token) {
+ return token.update(porterStemmer);
+ }
+})();
+
+lunr.Pipeline.registerFunction(lunr.stemmer, 'stemmer')
+/*!
+ * lunr.stopWordFilter
+ * Copyright (C) 2020 Oliver Nightingale
+ */
+
+/**
+ * lunr.generateStopWordFilter builds a stopWordFilter function from the provided
+ * list of stop words.
+ *
+ * The built in lunr.stopWordFilter is built using this generator and can be used
+ * to generate custom stopWordFilters for applications or non English languages.
+ *
+ * @function
+ * @param {Array} token The token to pass through the filter
+ * @returns {lunr.PipelineFunction}
+ * @see lunr.Pipeline
+ * @see lunr.stopWordFilter
+ */
+lunr.generateStopWordFilter = function (stopWords) {
+ var words = stopWords.reduce(function (memo, stopWord) {
+ memo[stopWord] = stopWord
+ return memo
+ }, {})
+
+ return function (token) {
+ if (token && words[token.toString()] !== token.toString()) return token
+ }
+}
+
+/**
+ * lunr.stopWordFilter is an English language stop word list filter, any words
+ * contained in the list will not be passed through the filter.
+ *
+ * This is intended to be used in the Pipeline. If the token does not pass the
+ * filter then undefined will be returned.
+ *
+ * @function
+ * @implements {lunr.PipelineFunction}
+ * @params {lunr.Token} token - A token to check for being a stop word.
+ * @returns {lunr.Token}
+ * @see {@link lunr.Pipeline}
+ */
+lunr.stopWordFilter = lunr.generateStopWordFilter([
+ 'a',
+ 'able',
+ 'about',
+ 'across',
+ 'after',
+ 'all',
+ 'almost',
+ 'also',
+ 'am',
+ 'among',
+ 'an',
+ 'and',
+ 'any',
+ 'are',
+ 'as',
+ 'at',
+ 'be',
+ 'because',
+ 'been',
+ 'but',
+ 'by',
+ 'can',
+ 'cannot',
+ 'could',
+ 'dear',
+ 'did',
+ 'do',
+ 'does',
+ 'either',
+ 'else',
+ 'ever',
+ 'every',
+ 'for',
+ 'from',
+ 'get',
+ 'got',
+ 'had',
+ 'has',
+ 'have',
+ 'he',
+ 'her',
+ 'hers',
+ 'him',
+ 'his',
+ 'how',
+ 'however',
+ 'i',
+ 'if',
+ 'in',
+ 'into',
+ 'is',
+ 'it',
+ 'its',
+ 'just',
+ 'least',
+ 'let',
+ 'like',
+ 'likely',
+ 'may',
+ 'me',
+ 'might',
+ 'most',
+ 'must',
+ 'my',
+ 'neither',
+ 'no',
+ 'nor',
+ 'not',
+ 'of',
+ 'off',
+ 'often',
+ 'on',
+ 'only',
+ 'or',
+ 'other',
+ 'our',
+ 'own',
+ 'rather',
+ 'said',
+ 'say',
+ 'says',
+ 'she',
+ 'should',
+ 'since',
+ 'so',
+ 'some',
+ 'than',
+ 'that',
+ 'the',
+ 'their',
+ 'them',
+ 'then',
+ 'there',
+ 'these',
+ 'they',
+ 'this',
+ 'tis',
+ 'to',
+ 'too',
+ 'twas',
+ 'us',
+ 'wants',
+ 'was',
+ 'we',
+ 'were',
+ 'what',
+ 'when',
+ 'where',
+ 'which',
+ 'while',
+ 'who',
+ 'whom',
+ 'why',
+ 'will',
+ 'with',
+ 'would',
+ 'yet',
+ 'you',
+ 'your'
+])
+
+lunr.Pipeline.registerFunction(lunr.stopWordFilter, 'stopWordFilter')
+/*!
+ * lunr.trimmer
+ * Copyright (C) 2020 Oliver Nightingale
+ */
+
+/**
+ * lunr.trimmer is a pipeline function for trimming non word
+ * characters from the beginning and end of tokens before they
+ * enter the index.
+ *
+ * This implementation may not work correctly for non latin
+ * characters and should either be removed or adapted for use
+ * with languages with non-latin characters.
+ *
+ * @static
+ * @implements {lunr.PipelineFunction}
+ * @param {lunr.Token} token The token to pass through the filter
+ * @returns {lunr.Token}
+ * @see lunr.Pipeline
+ */
+lunr.trimmer = function (token) {
+ return token.update(function (s) {
+ return s.replace(/^\W+/, '').replace(/\W+$/, '')
+ })
+}
+
+lunr.Pipeline.registerFunction(lunr.trimmer, 'trimmer')
+/*!
+ * lunr.TokenSet
+ * Copyright (C) 2020 Oliver Nightingale
+ */
+
+/**
+ * A token set is used to store the unique list of all tokens
+ * within an index. Token sets are also used to represent an
+ * incoming query to the index, this query token set and index
+ * token set are then intersected to find which tokens to look
+ * up in the inverted index.
+ *
+ * A token set can hold multiple tokens, as in the case of the
+ * index token set, or it can hold a single token as in the
+ * case of a simple query token set.
+ *
+ * Additionally token sets are used to perform wildcard matching.
+ * Leading, contained and trailing wildcards are supported, and
+ * from this edit distance matching can also be provided.
+ *
+ * Token sets are implemented as a minimal finite state automata,
+ * where both common prefixes and suffixes are shared between tokens.
+ * This helps to reduce the space used for storing the token set.
+ *
+ * @constructor
+ */
+lunr.TokenSet = function () {
+ this.final = false
+ this.edges = {}
+ this.id = lunr.TokenSet._nextId
+ lunr.TokenSet._nextId += 1
+}
+
+/**
+ * Keeps track of the next, auto increment, identifier to assign
+ * to a new tokenSet.
+ *
+ * TokenSets require a unique identifier to be correctly minimised.
+ *
+ * @private
+ */
+lunr.TokenSet._nextId = 1
+
+/**
+ * Creates a TokenSet instance from the given sorted array of words.
+ *
+ * @param {String[]} arr - A sorted array of strings to create the set from.
+ * @returns {lunr.TokenSet}
+ * @throws Will throw an error if the input array is not sorted.
+ */
+lunr.TokenSet.fromArray = function (arr) {
+ var builder = new lunr.TokenSet.Builder
+
+ for (var i = 0, len = arr.length; i < len; i++) {
+ builder.insert(arr[i])
+ }
+
+ builder.finish()
+ return builder.root
+}
+
+/**
+ * Creates a token set from a query clause.
+ *
+ * @private
+ * @param {Object} clause - A single clause from lunr.Query.
+ * @param {string} clause.term - The query clause term.
+ * @param {number} [clause.editDistance] - The optional edit distance for the term.
+ * @returns {lunr.TokenSet}
+ */
+lunr.TokenSet.fromClause = function (clause) {
+ if ('editDistance' in clause) {
+ return lunr.TokenSet.fromFuzzyString(clause.term, clause.editDistance)
+ } else {
+ return lunr.TokenSet.fromString(clause.term)
+ }
+}
+
+/**
+ * Creates a token set representing a single string with a specified
+ * edit distance.
+ *
+ * Insertions, deletions, substitutions and transpositions are each
+ * treated as an edit distance of 1.
+ *
+ * Increasing the allowed edit distance will have a dramatic impact
+ * on the performance of both creating and intersecting these TokenSets.
+ * It is advised to keep the edit distance less than 3.
+ *
+ * @param {string} str - The string to create the token set from.
+ * @param {number} editDistance - The allowed edit distance to match.
+ * @returns {lunr.Vector}
+ */
+lunr.TokenSet.fromFuzzyString = function (str, editDistance) {
+ var root = new lunr.TokenSet
+
+ var stack = [{
+ node: root,
+ editsRemaining: editDistance,
+ str: str
+ }]
+
+ while (stack.length) {
+ var frame = stack.pop()
+
+ // no edit
+ if (frame.str.length > 0) {
+ var char = frame.str.charAt(0),
+ noEditNode
+
+ if (char in frame.node.edges) {
+ noEditNode = frame.node.edges[char]
+ } else {
+ noEditNode = new lunr.TokenSet
+ frame.node.edges[char] = noEditNode
+ }
+
+ if (frame.str.length == 1) {
+ noEditNode.final = true
+ }
+
+ stack.push({
+ node: noEditNode,
+ editsRemaining: frame.editsRemaining,
+ str: frame.str.slice(1)
+ })
+ }
+
+ if (frame.editsRemaining == 0) {
+ continue
+ }
+
+ // insertion
+ if ("*" in frame.node.edges) {
+ var insertionNode = frame.node.edges["*"]
+ } else {
+ var insertionNode = new lunr.TokenSet
+ frame.node.edges["*"] = insertionNode
+ }
+
+ if (frame.str.length == 0) {
+ insertionNode.final = true
+ }
+
+ stack.push({
+ node: insertionNode,
+ editsRemaining: frame.editsRemaining - 1,
+ str: frame.str
+ })
+
+ // deletion
+ // can only do a deletion if we have enough edits remaining
+ // and if there are characters left to delete in the string
+ if (frame.str.length > 1) {
+ stack.push({
+ node: frame.node,
+ editsRemaining: frame.editsRemaining - 1,
+ str: frame.str.slice(1)
+ })
+ }
+
+ // deletion
+ // just removing the last character from the str
+ if (frame.str.length == 1) {
+ frame.node.final = true
+ }
+
+ // substitution
+ // can only do a substitution if we have enough edits remaining
+ // and if there are characters left to substitute
+ if (frame.str.length >= 1) {
+ if ("*" in frame.node.edges) {
+ var substitutionNode = frame.node.edges["*"]
+ } else {
+ var substitutionNode = new lunr.TokenSet
+ frame.node.edges["*"] = substitutionNode
+ }
+
+ if (frame.str.length == 1) {
+ substitutionNode.final = true
+ }
+
+ stack.push({
+ node: substitutionNode,
+ editsRemaining: frame.editsRemaining - 1,
+ str: frame.str.slice(1)
+ })
+ }
+
+ // transposition
+ // can only do a transposition if there are edits remaining
+ // and there are enough characters to transpose
+ if (frame.str.length > 1) {
+ var charA = frame.str.charAt(0),
+ charB = frame.str.charAt(1),
+ transposeNode
+
+ if (charB in frame.node.edges) {
+ transposeNode = frame.node.edges[charB]
+ } else {
+ transposeNode = new lunr.TokenSet
+ frame.node.edges[charB] = transposeNode
+ }
+
+ if (frame.str.length == 1) {
+ transposeNode.final = true
+ }
+
+ stack.push({
+ node: transposeNode,
+ editsRemaining: frame.editsRemaining - 1,
+ str: charA + frame.str.slice(2)
+ })
+ }
+ }
+
+ return root
+}
+
+/**
+ * Creates a TokenSet from a string.
+ *
+ * The string may contain one or more wildcard characters (*)
+ * that will allow wildcard matching when intersecting with
+ * another TokenSet.
+ *
+ * @param {string} str - The string to create a TokenSet from.
+ * @returns {lunr.TokenSet}
+ */
+lunr.TokenSet.fromString = function (str) {
+ var node = new lunr.TokenSet,
+ root = node
+
+ /*
+ * Iterates through all characters within the passed string
+ * appending a node for each character.
+ *
+ * When a wildcard character is found then a self
+ * referencing edge is introduced to continually match
+ * any number of any characters.
+ */
+ for (var i = 0, len = str.length; i < len; i++) {
+ var char = str[i],
+ final = (i == len - 1)
+
+ if (char == "*") {
+ node.edges[char] = node
+ node.final = final
+
+ } else {
+ var next = new lunr.TokenSet
+ next.final = final
+
+ node.edges[char] = next
+ node = next
+ }
+ }
+
+ return root
+}
+
+/**
+ * Converts this TokenSet into an array of strings
+ * contained within the TokenSet.
+ *
+ * This is not intended to be used on a TokenSet that
+ * contains wildcards, in these cases the results are
+ * undefined and are likely to cause an infinite loop.
+ *
+ * @returns {string[]}
+ */
+lunr.TokenSet.prototype.toArray = function () {
+ var words = []
+
+ var stack = [{
+ prefix: "",
+ node: this
+ }]
+
+ while (stack.length) {
+ var frame = stack.pop(),
+ edges = Object.keys(frame.node.edges),
+ len = edges.length
+
+ if (frame.node.final) {
+ /* In Safari, at this point the prefix is sometimes corrupted, see:
+ * https://github.com/olivernn/lunr.js/issues/279 Calling any
+ * String.prototype method forces Safari to "cast" this string to what
+ * it's supposed to be, fixing the bug. */
+ frame.prefix.charAt(0)
+ words.push(frame.prefix)
+ }
+
+ for (var i = 0; i < len; i++) {
+ var edge = edges[i]
+
+ stack.push({
+ prefix: frame.prefix.concat(edge),
+ node: frame.node.edges[edge]
+ })
+ }
+ }
+
+ return words
+}
+
+/**
+ * Generates a string representation of a TokenSet.
+ *
+ * This is intended to allow TokenSets to be used as keys
+ * in objects, largely to aid the construction and minimisation
+ * of a TokenSet. As such it is not designed to be a human
+ * friendly representation of the TokenSet.
+ *
+ * @returns {string}
+ */
+lunr.TokenSet.prototype.toString = function () {
+ // NOTE: Using Object.keys here as this.edges is very likely
+ // to enter 'hash-mode' with many keys being added
+ //
+ // avoiding a for-in loop here as it leads to the function
+ // being de-optimised (at least in V8). From some simple
+ // benchmarks the performance is comparable, but allowing
+ // V8 to optimize may mean easy performance wins in the future.
+
+ if (this._str) {
+ return this._str
+ }
+
+ var str = this.final ? '1' : '0',
+ labels = Object.keys(this.edges).sort(),
+ len = labels.length
+
+ for (var i = 0; i < len; i++) {
+ var label = labels[i],
+ node = this.edges[label]
+
+ str = str + label + node.id
+ }
+
+ return str
+}
+
+/**
+ * Returns a new TokenSet that is the intersection of
+ * this TokenSet and the passed TokenSet.
+ *
+ * This intersection will take into account any wildcards
+ * contained within the TokenSet.
+ *
+ * @param {lunr.TokenSet} b - An other TokenSet to intersect with.
+ * @returns {lunr.TokenSet}
+ */
+lunr.TokenSet.prototype.intersect = function (b) {
+ var output = new lunr.TokenSet,
+ frame = undefined
+
+ var stack = [{
+ qNode: b,
+ output: output,
+ node: this
+ }]
+
+ while (stack.length) {
+ frame = stack.pop()
+
+ // NOTE: As with the #toString method, we are using
+ // Object.keys and a for loop instead of a for-in loop
+ // as both of these objects enter 'hash' mode, causing
+ // the function to be de-optimised in V8
+ var qEdges = Object.keys(frame.qNode.edges),
+ qLen = qEdges.length,
+ nEdges = Object.keys(frame.node.edges),
+ nLen = nEdges.length
+
+ for (var q = 0; q < qLen; q++) {
+ var qEdge = qEdges[q]
+
+ for (var n = 0; n < nLen; n++) {
+ var nEdge = nEdges[n]
+
+ if (nEdge == qEdge || qEdge == '*') {
+ var node = frame.node.edges[nEdge],
+ qNode = frame.qNode.edges[qEdge],
+ final = node.final && qNode.final,
+ next = undefined
+
+ if (nEdge in frame.output.edges) {
+ // an edge already exists for this character
+ // no need to create a new node, just set the finality
+ // bit unless this node is already final
+ next = frame.output.edges[nEdge]
+ next.final = next.final || final
+
+ } else {
+ // no edge exists yet, must create one
+ // set the finality bit and insert it
+ // into the output
+ next = new lunr.TokenSet
+ next.final = final
+ frame.output.edges[nEdge] = next
+ }
+
+ stack.push({
+ qNode: qNode,
+ output: next,
+ node: node
+ })
+ }
+ }
+ }
+ }
+
+ return output
+}
+lunr.TokenSet.Builder = function () {
+ this.previousWord = ""
+ this.root = new lunr.TokenSet
+ this.uncheckedNodes = []
+ this.minimizedNodes = {}
+}
+
+lunr.TokenSet.Builder.prototype.insert = function (word) {
+ var node,
+ commonPrefix = 0
+
+ if (word < this.previousWord) {
+ throw new Error ("Out of order word insertion")
+ }
+
+ for (var i = 0; i < word.length && i < this.previousWord.length; i++) {
+ if (word[i] != this.previousWord[i]) break
+ commonPrefix++
+ }
+
+ this.minimize(commonPrefix)
+
+ if (this.uncheckedNodes.length == 0) {
+ node = this.root
+ } else {
+ node = this.uncheckedNodes[this.uncheckedNodes.length - 1].child
+ }
+
+ for (var i = commonPrefix; i < word.length; i++) {
+ var nextNode = new lunr.TokenSet,
+ char = word[i]
+
+ node.edges[char] = nextNode
+
+ this.uncheckedNodes.push({
+ parent: node,
+ char: char,
+ child: nextNode
+ })
+
+ node = nextNode
+ }
+
+ node.final = true
+ this.previousWord = word
+}
+
+lunr.TokenSet.Builder.prototype.finish = function () {
+ this.minimize(0)
+}
+
+lunr.TokenSet.Builder.prototype.minimize = function (downTo) {
+ for (var i = this.uncheckedNodes.length - 1; i >= downTo; i--) {
+ var node = this.uncheckedNodes[i],
+ childKey = node.child.toString()
+
+ if (childKey in this.minimizedNodes) {
+ node.parent.edges[node.char] = this.minimizedNodes[childKey]
+ } else {
+ // Cache the key for this node since
+ // we know it can't change anymore
+ node.child._str = childKey
+
+ this.minimizedNodes[childKey] = node.child
+ }
+
+ this.uncheckedNodes.pop()
+ }
+}
+/*!
+ * lunr.Index
+ * Copyright (C) 2020 Oliver Nightingale
+ */
+
+/**
+ * An index contains the built index of all documents and provides a query interface
+ * to the index.
+ *
+ * Usually instances of lunr.Index will not be created using this constructor, instead
+ * lunr.Builder should be used to construct new indexes, or lunr.Index.load should be
+ * used to load previously built and serialized indexes.
+ *
+ * @constructor
+ * @param {Object} attrs - The attributes of the built search index.
+ * @param {Object} attrs.invertedIndex - An index of term/field to document reference.
+ * @param {Object' + noResultsText + '
'); + } +} + +function doSearch () { + var query = document.getElementById('mkdocs-search-query').value; + if (query.length > min_search_length) { + if (!window.Worker) { + displayResults(search(query)); + } else { + searchWorker.postMessage({query: query}); + } + } else { + // Clear results for short queries + displayResults([]); + } +} + +function initSearch () { + var search_input = document.getElementById('mkdocs-search-query'); + if (search_input) { + search_input.addEventListener("keyup", doSearch); + } + var term = getSearchTermFromLocation(); + if (term) { + search_input.value = term; + doSearch(); + } +} + +function onWorkerMessage (e) { + if (e.data.allowSearch) { + initSearch(); + } else if (e.data.results) { + var results = e.data.results; + displayResults(results); + } else if (e.data.config) { + min_search_length = e.data.config.min_search_length-1; + } +} + +if (!window.Worker) { + console.log('Web Worker API not supported'); + // load index in main thread + $.getScript(joinUrl(base_url, "search/worker.js")).done(function () { + console.log('Loaded worker'); + init(); + window.postMessage = function (msg) { + onWorkerMessage({data: msg}); + }; + }).fail(function (jqxhr, settings, exception) { + console.error('Could not load worker.js'); + }); +} else { + // Wrap search in a web worker + var searchWorker = new Worker(joinUrl(base_url, "search/worker.js")); + searchWorker.postMessage({init: true}); + searchWorker.onmessage = onWorkerMessage; +} diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 0000000..6600d60 --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"Top level commands: | command | description | |-------------|-----------------------------------------------------------| | aid http | HTTP functions | | aid ip | IP information / scanning | | aid port | Port information / scanning | | aid cpu | System cpu information | | aid mem | System memory information | | aid disk | System disk information | | aid network | System network information | | aid process | Display process information | | aid json | JSON parsing / extraction functions | | aid csv | CSV search / transformation functions | | aid text | Text manipulation functions | | aid file | File info functions | | aid time | Time related functions | | aid bits | Bit manipulation functions | | aid math | Math functions | | aid help | Print this message or the help of the given subcommand(s) | All commands: | version | command | description | |-----------|------------------------|------------------------------------------------------------| | [u] 0.1.3 | aid http req | Make a HTTP request | | [u] 0.1.3 | aid http serve | Start a dummy HTTP server | | [u] 0.1.3 | aid ip local | Show my local IP address | | [u] 0.1.3 | aid ip public | Show my public IP address | | [u] 0.1.3 | aid ip scan | Scan a specified IP address subnet for active ip addresses | | [u] 0.1.3 | aid ip status | Try to connect to the specified IP address | | [u] 0.1.3 | aid port status | Check if the specified port is 'open' or 'closed'. | | [u] 0.1.3 | aid port scan | Scan for open ports on a specified IP address | | [u] 0.1.3 | aid cpu info | Show CPU information | | [u] 0.1.6 | aid cpu usage | Monitor CPU usage | | [u] 0.1.6 | aid mem usage | Monitor memory usage | | [u] 0.1.3 | aid disk info | Show disk information | | [u] 0.1.3 | aid network info | Show network information | | [u] 0.1.3 | aid network usage | Display network usage | | [a] 0.1.7 | aid process usage | Display process usage | | [u] 0.1.3 | aid json extract | Extract a property from JSON data | | [u] 0.1.3 | aid json jwt-decode | Decode a JWT | | [u] 0.1.3 | aid csv search | Sql search over csv | | [u] 0.1.3 | aid text base64-encode | encodes a base64 string | | [u] 0.1.3 | aid text base64-decode | decodes a base64 string | | [u] 0.1.3 | aid text lines | reads and prints lines from a text file | | [u] 0.1.3 | aid file info | prints file metadata | | [u] 0.1.3 | aid file md5 | calculates the files Md5 checksum | | [u] 0.1.3 | aid file sha1 | calculates the files Sha1 checksum | | [u] 0.1.3 | aid file sha256 | calculates the files Sha256 checksum | | [a] 0.1.4 | aid file zip | zips the files in the source directory | | [u] 0.1.9 | aid time unix | Display unix timestamp | | [u] 0.1.9 | aid time dt | Display the datetime | | [a] 0.1.9 | aid time chron | Describes a chron job | | [a] 0.1.9 | aid time count-down | Starts a countdown timer | | [a] 0.1.8 | aid bits eval | Bitwise expression evaluation / conversion / information | | [u] 0.1.3 | aid math eval | Evaluates a math expression | | [u] 0.1.3 | aid math plot | Plot a math expression | [a] added in version x.x.x [u] lasted updated in version x.x.x [p] last patched in version x.x.x [d] deprecated in version x.x.x Support \ud83d\udedf Need help? Ping me on linkedin and I'd be more then happy to jump on a call to debug, help configure or answer any questions.","title":"Overview \u2705"},{"location":"#top-level-commands","text":"| command | description | |-------------|-----------------------------------------------------------| | aid http | HTTP functions | | aid ip | IP information / scanning | | aid port | Port information / scanning | | aid cpu | System cpu information | | aid mem | System memory information | | aid disk | System disk information | | aid network | System network information | | aid process | Display process information | | aid json | JSON parsing / extraction functions | | aid csv | CSV search / transformation functions | | aid text | Text manipulation functions | | aid file | File info functions | | aid time | Time related functions | | aid bits | Bit manipulation functions | | aid math | Math functions | | aid help | Print this message or the help of the given subcommand(s) |","title":"Top level commands:"},{"location":"#all-commands","text":"| version | command | description | |-----------|------------------------|------------------------------------------------------------| | [u] 0.1.3 | aid http req | Make a HTTP request | | [u] 0.1.3 | aid http serve | Start a dummy HTTP server | | [u] 0.1.3 | aid ip local | Show my local IP address | | [u] 0.1.3 | aid ip public | Show my public IP address | | [u] 0.1.3 | aid ip scan | Scan a specified IP address subnet for active ip addresses | | [u] 0.1.3 | aid ip status | Try to connect to the specified IP address | | [u] 0.1.3 | aid port status | Check if the specified port is 'open' or 'closed'. | | [u] 0.1.3 | aid port scan | Scan for open ports on a specified IP address | | [u] 0.1.3 | aid cpu info | Show CPU information | | [u] 0.1.6 | aid cpu usage | Monitor CPU usage | | [u] 0.1.6 | aid mem usage | Monitor memory usage | | [u] 0.1.3 | aid disk info | Show disk information | | [u] 0.1.3 | aid network info | Show network information | | [u] 0.1.3 | aid network usage | Display network usage | | [a] 0.1.7 | aid process usage | Display process usage | | [u] 0.1.3 | aid json extract | Extract a property from JSON data | | [u] 0.1.3 | aid json jwt-decode | Decode a JWT | | [u] 0.1.3 | aid csv search | Sql search over csv | | [u] 0.1.3 | aid text base64-encode | encodes a base64 string | | [u] 0.1.3 | aid text base64-decode | decodes a base64 string | | [u] 0.1.3 | aid text lines | reads and prints lines from a text file | | [u] 0.1.3 | aid file info | prints file metadata | | [u] 0.1.3 | aid file md5 | calculates the files Md5 checksum | | [u] 0.1.3 | aid file sha1 | calculates the files Sha1 checksum | | [u] 0.1.3 | aid file sha256 | calculates the files Sha256 checksum | | [a] 0.1.4 | aid file zip | zips the files in the source directory | | [u] 0.1.9 | aid time unix | Display unix timestamp | | [u] 0.1.9 | aid time dt | Display the datetime | | [a] 0.1.9 | aid time chron | Describes a chron job | | [a] 0.1.9 | aid time count-down | Starts a countdown timer | | [a] 0.1.8 | aid bits eval | Bitwise expression evaluation / conversion / information | | [u] 0.1.3 | aid math eval | Evaluates a math expression | | [u] 0.1.3 | aid math plot | Plot a math expression | [a] added in version x.x.x [u] lasted updated in version x.x.x [p] last patched in version x.x.x [d] deprecated in version x.x.x","title":"All commands:"},{"location":"#support","text":"Need help? Ping me on linkedin and I'd be more then happy to jump on a call to debug, help configure or answer any questions.","title":"Support \ud83d\udedf"},{"location":"contributing/","text":"Contributing \ud83d\ude4f Contributions are welcome! Here\u2019s how you can get involved: Fork the repository : Click the \"Fork\" button at the top right of this page. Clone your fork : git clone https://github.com/Timmoth/aid-cli.git Create a branch : Make your changes in a new branch. git checkout -b my-feature-branch Commit your changes : git commit -m 'Add some feature' Push to the branch : git push origin my-feature-branch Open a pull request : Describe your changes and submit your PR.","title":"Contributing \ud83d\ude4f"},{"location":"contributing/#contributing","text":"Contributions are welcome! Here\u2019s how you can get involved: Fork the repository : Click the \"Fork\" button at the top right of this page. Clone your fork : git clone https://github.com/Timmoth/aid-cli.git Create a branch : Make your changes in a new branch. git checkout -b my-feature-branch Commit your changes : git commit -m 'Add some feature' Push to the branch : git push origin my-feature-branch Open a pull request : Describe your changes and submit your PR.","title":"Contributing \ud83d\ude4f"},{"location":"quickstart/","text":"Installation Manual installation is simple, just download the release and add it to your PATH environment variable, if you'd like an even easier way i've added scripts to do it for you. Linux / Mac wget https://raw.githubusercontent.com/Timmoth/aid-cli/refs/heads/main/install.sh chmod +x install.sh sudo ./install.sh Windows (powershell) Invoke-WebRequest -Uri https://raw.githubusercontent.com/Timmoth/aid-cli/refs/heads/main/install.ps1 -OutFile install.ps1 Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass -Force .\\install.ps1 Releases Download the latest release Build If you'd like to build the latest version from source: //Install rust https://www.rust-lang.org/tools/install git clone https://github.com/Timmoth/aid-cli cd aid-cli cargo build --release .\\target\\release\\aid.exe","title":"Quick start \u25b6\ufe0f"},{"location":"quickstart/#installation","text":"Manual installation is simple, just download the release and add it to your PATH environment variable, if you'd like an even easier way i've added scripts to do it for you.","title":"Installation"},{"location":"quickstart/#linux-mac","text":"wget https://raw.githubusercontent.com/Timmoth/aid-cli/refs/heads/main/install.sh chmod +x install.sh sudo ./install.sh","title":"Linux / Mac"},{"location":"quickstart/#windows-powershell","text":"Invoke-WebRequest -Uri https://raw.githubusercontent.com/Timmoth/aid-cli/refs/heads/main/install.ps1 -OutFile install.ps1 Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass -Force .\\install.ps1","title":"Windows (powershell)"},{"location":"quickstart/#releases","text":"Download the latest release","title":"Releases"},{"location":"quickstart/#build","text":"If you'd like to build the latest version from source: //Install rust https://www.rust-lang.org/tools/install git clone https://github.com/Timmoth/aid-cli cd aid-cli cargo build --release .\\target\\release\\aid.exe","title":"Build"},{"location":"support/","text":"Need help? Ping me on linkedin and I'd be more then happy to jump on a call to debug, help configure or answer any questions.","title":"Support \ud83d\udedf"},{"location":"features/bits/","text":"aid bits eval aid bits eval