oafp reference list of examples

Examples of use of oafp avaiable also in https://ojob.io/oafp-examples.yaml.

📚 Contents

Category	Sub-category	#	Description
AI	BedRock	1	List all AWS BedRock models available to use.
AI	BedRock	2	Place a prompt to get a list of data using AWS BedRock titan express model.
AI	BedRock	3	Place a prompt to get a list of data using an AWS BedRock Llama model.
AI	BedRock	4	Using AWS BedRock Mistral model to place a prompt
AI	BedRock	5	Using AWS BedRock to place a prompt to an AWS Nova model to get an Unix command to find all javascript files older than 1 day
AI	Classification	6	Given a list of news titles with corresponding dates and sources add a category and sub-category field to each
AI	Classification	7	Given the current news pipe the news title to an LLM model to add emoticons to each title.
AI	Classification	8	Using Google's Gemini model and a list of jar files will try to produce a table categorizing and describing the function of each jar file.
AI	Conversation	9	Send multiple requests to an OpenAI model keeping the conversation between interactions and setting the temperature parameter
AI	DeepSeek	10	Given a list of files and their corresponding sizes use DeepSeek R1 model to produce a list of 5 files that would be interesting to use to test an ETL tool.
AI	Evaluate	11	Given a strace summary of the execution of a command (CMD) use a LLM to describe a reason on the results obtained.
AI	Gemini	12	Use Google's Gemini LLM model together with Google Search to obtain the current top 10 news titles around the world
AI	Generate data	13	Generates synthetic data making parallel prompts to a LLM model and then cleaning up the result removing duplicate records into a final csv file.
AI	Generate data	14	Generates synthetic data using a LLM model and then uses the recorded conversation to generate more data respecting the provided instructions
AI	GitHub models	15	Basic example to use GitHub Models inference with oafp
AI	Groq	16	Calculation
AI	Mistral	17	List all available LLM models at mistral.ai
AI	Ollama	18	Given the current list of Ollama models will try to pull each one of them in parallel
AI	Ollama	19	Setting up access to Ollama and ask for data to an AI LLM model
AI	OpenAI	20	Setting up the OpenAI LLM model and gather the data into a data.json file
AI	Perplexity	21	Basic example to use Perplexity AI API with oafp
AI	Prompt	22	Example of generating data from an AI LLM prompt
AI	Scaleway	23	Setting up a Scaleway Generative API LLM connection and ask for a list of all Roman emperors.
AI	Summarize	24	Use an AI LLM model to summarize the weather information provided in a JSON format
AI	Template	25	Convert oAFp llmconversation JSON file into a HTML of the LLM conversation
AI	Template	26	Convert oAFp llmconversation JSON file into a terminal readable template of the LLM conversation
AI	TogetherAI	27	List all available LLM models at together.ai with their corresponding type and price components order by the more expensive, for input and output
APIs	NASA	28	Markdown table of near Earth objects by name, magnitude, if is potentially hazardous asteroids and corresponding distance
APIs	Network	29	Converting the Cloudflare DNS trace info
APIs	Network	30	Converting the Google DNS DoH query result
APIs	Network	31	Generating a simple map of the current public IP address
APIs	Public Holidays	32	Return the public holidays for a given country on a given year
APIs	Space	33	How many people are in space and in which craft currently in space
APIs	iTunes	34	Search the Apple's iTunes database for a specific term
AWS	AMIs	35	List Amazon Linux 2023 available EC2 AMI images for a specific AWS region
AWS	DynamoDB	36	Given an AWS DynamoDB table 'my-table' will produce a ndjson output with all table items.
AWS	DynamoDB	37	Given an AWS DynamoDB table 'my-users' will produce a colored tree output by getting the item for the email key 'scott.tiger@example.com'
AWS	EC2	38	Given all AWS EC2 instances in an account produces a table with name, type, vpc and private ip sorted by vpc
AWS	EKS	39	Builds an excel spreadsheet with all persistent volumes associated with an AWS EKS 'XYZ' with the corresponding Kubernetes namespace, pvc and pv names
AWS	EKS	40	Produce a list of all AWS EKS Kubernetes service accounts, per namespace, which have an AWS IAM role associated with it.
AWS	Inspector	41	Given an AWS ECR repository and image tag retrieve the AWS Inspector vulnerabilities and list a quick overview in an Excel spreadsheet
AWS	Lambda	42	Prepares a table of AWS Lambda functions with their corresponding main details
AWS	Lambda	43	Prepares a table, for a specific AWS Lambda function during a specific time periods, with number of invocations and minimum, average and maximum duration per periods from AWS CloudWatch
AWS	RDS Data	44	Given an AWS RDS, postgresql based, database with RDS Data API activated execute the 'analyze' statement for each table on the 'public' schema.
AWS	VPC	45	On an AWS account go through all AWS regions and produce an output table with each VPC CIDR
Azure	Bing	46	Given an Azure Bing Search API key and a query returns the corresponding search result from Bing.
Channels	S3	47	Given a S3 bucket will load data from a previously store data in a provided prefix
Channels	S3	48	Given a S3 bucket will save a list of data (the current list of name and versions of OpenAF's oPacks) within a provided prefix
Chart	Unix	49	Output a chart with the current Unix load using uptime
DB	H2	50	Perform a SQL query over a H2 database.
DB	H2	51	Perform queries and DML SQL statements over a H2 databases
DB	H2	52	Store the json result of a command into a H2 database table.
DB	List	53	List all OpenAF's oPack pre-prepared JDBC drivers
DB	Mongo	54	List all records from a specific MongoDB database and collection from a remote Mongo database.
DB	PostgreSQL	55	Given a JDBC postgresql connection retrieve schema information (DDL) of all tables.
DB	SQLite	56	Lists all files in openaf.jar, stores the result in a 'data' table on a SQLite data.db file and performs a query over the stored data.
DB	SQLite	57	Perform a query over a database using JDBC.
DB	SQLite	58	Store the json result on a SQLite database table.
Diff	Envs	59	Given two JSON files with environment variables performs a diff and returns a colored result with the corresponding differences
Diff	Lines	60	Performing a diff between two long command lines to spot differences
Diff	Path	61	Given two JSON files with the parsed PATH environment variable performs a diff and returns a colored result with the corresponding differences
Docker	Containers	62	Output a table with the list of running containers.
Docker	Listing	63	List all containers with the docker-compose project, service name, file, id, name, image, creation time, status, networks and ports.
Docker	Listing	64	List all containers with their corresponding labels parsed and sorted.
Docker	Network	65	Output a table with the docker networks info.
Docker	Registry	66	List all a table of docker container images repository and corresponding tags of a private registry.
Docker	Registry	67	List all the docker container image repositories of a private registry.
Docker	Registry	68	List all the docker container image repository tags of a private registry.
Docker	Stats	69	Output a table with the docker stats broken down for each value.
Docker	Storage	70	Output a table with the docker volumes info.
Docker	Volumes	71	Given a list of docker volumes will remove all of them, if not in use, in parallel for faster execution.
ElasticSearch	Cluster	72	Get an ElasticSearch/OpenSearch cluster nodes overview
ElasticSearch	Cluster	73	Get an ElasticSearch/OpenSearch cluster per host data allocation
ElasticSearch	Cluster	74	Get an ElasticSearch/OpenSearch cluster settings flat
ElasticSearch	Cluster	75	Get an ElasticSearch/OpenSearch cluster settings non-flatted
ElasticSearch	Cluster	76	Get an ElasticSearch/OpenSearch cluster stats per node
ElasticSearch	Cluster	77	Get an overview of an ElasticSearch/OpenSearch cluster health
ElasticSearch	Indices	78	Get an ElasticSearch/OpenSearch count per index
ElasticSearch	Indices	79	Get an ElasticSearch/OpenSearch indices overview
ElasticSearch	Indices	80	Get an ElasticSearch/OpenSearch settings for a specific index
GIT	History	81	Give a GIT repository will retrieve the current log history and parse it to an Excel (XLS) file.
GPU	Nvidia	82	Builds a grid with two charts providing a visualization over a Nvidia GPU usage and the corresponding memory usage for a specific GPU_IDX (gpu index)
GPU	Nvidia	83	Get current Nvidia per-gpu usage
Generic	Arrays	84	Converting an array of strings into an array of maps
Generic	Avro	85	Given an Avro data file outputs it's corresponding statistics
Generic	Avro	86	Given an Avro data file outputs the correspoding schema
Generic	Avro	87	Reads an Avro data file as input
Generic	Avro	88	Write an Avro data file as an output
Generic	BOM	89	Given a container image use syft to generate a table with a corresponding bill-of-materials (BOM) table with each identified artifact name, version, type, language, found path and maven group & id (if applicable).
Generic	Base64	90	Encode/decode data (or text-like files) to/from gzip base64 representation for easier packing and transport.
Generic	CSV	91	Given a BOM CSV with multiple fields (7 in total) return a new CSV with just 3 of the original fields.
Generic	Commands	92	Given an input array with phone numbers will run parallel output commands, calling ojob.io/telco/phoneNumber, for each entry effectively building an output from those multiple command executions.
Generic	End of life	93	List the versions of a given product with the corresponding end-of-life dates (using endofline.date API)
Generic	Excel	94	Building an Excel file with the AWS IPv4 and IPv6 ranges (1).
Generic	Excel	95	Building an Excel file with the AWS IPv4 and IPv6 ranges (2).
Generic	Excel	96	Building an Excel file with the AWS IPv4 and IPv6 ranges (3).
Generic	Excel	97	Processes each json file in /some/data creating and updating the data.xlsx file with a sheet for each file.
Generic	Excel	98	Store and retrieve data from an Excel spreadsheet
Generic	File listing	99	How to get the total abbreviated size of specific files using a SQL query
Generic	HTML	100	Generate a HTML with table of emoticons/emojis by category, group, name, unicode and html code.
Generic	HTML	101	Given an input file, in a specific language (e.g. yaml, json, bash, etc…), output an HTML representation with syntax highlighting.
Generic	Hex	102	Outputs an hexadecimal representation of the characters of the file provided allowing to adjust how many per line/row.
Generic	JWT	103	Generates an output JWT (JSON Web Token) given the provided input claims signed with a provided secret.
Generic	JWT	104	Given an input JWT (JSON Web Token) converts it to a human readable format.
Generic	List files	105	After listing all files and folders recursively producing a count table by file extension.
Generic	RSS	106	Builds an HTML file with the current linked news titles, publication date and source from Google News RSS.
Generic	RSS	107	Example of generating a HTML list of titles, links and publication dates from a RSS feed
Generic	RSS	108	Generates a HTML page with the current news from Google News, order by date, and opens a browser with it.
Generic	RSS	109	Parses the Slashdot's RSS feed news into a quick clickable HTML page in a browser
Generic	Reverse	110	Given a text file revert the line ordering
Generic	Set	111	Given two json files, with arrays of component versions, generate a table with the difference on one of the sides.
Generic	Set	112	Given two json files, with arrays of component versions, generate a table with the union of the two sides.
Generic	Template	113	Given a meal name will search 'The Meal DB' site for the corresponding recipe and render a markdown HTML of the corresponding recipe.
Generic	Text	114	Get a json with lyrics of a song.
Generic	Text	115	Search a word in the English dictionary returning phonetic, meanings, synonyms, antonyms, etc.
Generic	URL	116	Given an URL to a resource on a website determine how long ago is was modified given the data provided by the server.
Generic	YAML	117	Given an YAML file with a data array composed of maps with fields 'c', 's', 'd' and 'e' filter by any record where any field doesn't have contents.
GitHub	GIST	118	Using GitHub's GIST functionality retrieves and parses an oAFp examples YAML file with the template and the corresponding data.
GitHub	Releases	119	Builds a table of GitHub project releases
GitHub	Releases	120	Parses the latest GitHub project release markdown notes
Grid	Java	121	Parses a Java hsperf data + the current rss java process memory into a looping grid.
Grid	Java	122	Parses a Java hsperf data into a looping grid.
Grid	Kubernetes	123	Displays a continuous updating grid with a line chart with the number of CPU throtlles and bursts recorded in the Linux cgroup cpu stats of a container running in Kubernetes and the source cpu.stats data
Grid	Mac	124	Shows a grid with the Mac network metrics and 4 charts for in, out packets and in, out bytes
Grid	Mac	125	Shows a grid with the Mac storage metrics and 4 charts for read, write IOPS and read, write bytes per second
Grid	Unix	126	On an Unix/Linux system supporting 'ps' output formats %cpu and %mem, will output a chart with the percentage of cpu and memory usage of a provided pid (e.g. 12345)
JSON Schemas	Lists	127	Get a list of JSON schemas from Schema Store catalog
Java	Certificates	128	Given a Java keystore will obtain a list of certificates and output them order by the ones that will expire first.
Java	JFR	129	Convert the input of viewing allocation by site from a Java Flight Recorder (JFR) recording into a CSV output
Java	JFR	130	Given a Java Flight Recorder (JFR) recording produce a table order by class object allocation weigtht and count
Kubernetes	Base64	131	Given a Kubernetes Config Map or Secret with binary data, retrieves it and stores it locally in a binary file.
Kubernetes	Containers	132	Parse the Linux cgroup cpu stats on a container running in Kubernetes
Kubernetes	Helm	133	Given an Helm release name and the corresponding namespace will produce a table with the timestamps when the corresponding Helm chart hooks have started and completed for the lastest execution and the corresponding phase.
Kubernetes	Kubectl	134	Build a table of the images 'cached' in all Kubernetes nodes using Kubectl and, additionally, provide a summary of the total size per node.
Kubernetes	Kubectl	135	Build an output table with Kubernetes pods with namespace, pod name, container name and corresponding resources using kubectl
Kubernetes	Kubectl	136	Build an output table with Kubernetes pods with node, namespace, pod name, container name and corresponding resources using kubectl
Kubernetes	Kubectl	137	Executes a recursive file list find command in a specific pod, namespace and path converting the result into a table.
Kubernetes	Kubectl	138	Given a pod on a namespace loop through kubectl top and show a grid of two charts with the corresponding cpu and memory values.
Kubernetes	Kubectl	139	Given the list of all Kubernetes objects will produce a list of objects per namespace, kind, apiVersiom, creation timestamp, name and owner.
Kubernetes	Kubectl	140	List of Kubernetes CPU, memory and storage stats per node using kubectl
Kubernetes	Kubectl	141	List of Kubernetes pods per namespace and kind using kubectl
Kubernetes	Kubectl	142	Produces a list of pods' containers per namespace with the corresponding images and assigned nodes.
Kubernetes	Kubectl	143	Using kubectl with the appropriate permissions check the filesystem available, capacity and used bytes and inodes on each node of the Kubernetes cluster.
Kubernetes	PVC	144	Produces a table with all Kubernetes persistent volume claims (PVCs) in use by pods.
Mac	Activity	145	Uses the Mac terminal command 'last' output to build an activity table with user, tty, from, login-time and logout-time
Mac	Brew	146	List all the packages and corresponding versions installed in a Mac by brew.
Mac	Chart	147	On a Mac OS produce a looping chart with the total percentage of current CPU usage.
Mac	Info	148	Get a list of the current logged users in Mac OS
Mac	Info	149	Parses the current Mac OS hardware information
Mac	Info	150	Parses the current Mac OS overview information
Mac	Safari	151	Get a list of all Mac OS Safari bookmarks into a CSV file.
Mac	Tunnelblink	152	In a Mac OS with Tunnelblink, if you want to copy all your OpenVPN configurations into ovpn files.
Markdown	Tables	153	For an input markdown file, parse all tables, transform it to JSON and output as a colored table
Network	ASN	154	Retrieve an IP to ASN list list and converts it to ndjson
Network	ASN	155	Retrieve the list of ASN number and names from RIPE and transforms it to a CSV.
Network	Latency	156	Given a host and a port will display a continuously updating line chart with network latency, in ms, between the current device and the target host and port
Ollama	List models	157	Parses the list of models currently in an Ollama deployment
OpenAF	Channels	158	Copy the json result of a command into an etcd database using OpenAF's channels
OpenAF	Channels	159	Getting all data stored in an etcd database using OpenAF's channels
OpenAF	Channels	160	Given a Prometheus database will query for a specific metric (go_memstats_alloc_bytes), during a defined period, every 5 seconds (step) will produce a static chart with the corresponding metric values.
OpenAF	Channels	161	Perform a query to a metric & label, with a start and end time, to a Prometheus server using OpenAF's channels
OpenAF	Channels	162	Retrieve all keys stores in a H2 MVStore file using OpenAF's channels
OpenAF	Channels	163	Store and retrieve data from a Redis database
OpenAF	Channels	164	Store and retrieve data from a RocksDB database
OpenAF	Channels	165	Store the json results of a command into a H2 MVStore file using OpenAF's channels
OpenAF	Flags	166	List the current values of OpenAF/oAFp internal flags
OpenAF	Network	167	Gets all the DNS host addresses for a provided domain and ensures that the output is always a list
OpenAF	Network	168	List all MX (mail servers) network addresses from the current DNS server for a hostname using OpenAF
OpenAF	Network	169	List all network addresses returned from the current DNS server for a hostname using OpenAF
OpenAF	OS	170	Current OS information visible to OpenAF
OpenAF	OS	171	Using OpenAF parse the current environment variables
OpenAF	OpenVPN	172	Using OpenAF code to perform a more complex parsing of the OpenVPN status data running on an OpenVPN container (nmaguiar/openvpn) called 'openvpn'
OpenAF	SFTP	173	Generates a file list with filepath, size, permissions, create and last modified time from a SFTP connection with user and password
OpenAF	SFTP	174	Generates a file list with filepath, size, permissions, create and last modified time from a SFTP connection with user, private key and password
OpenAF	TLS	175	List the TLS certificates of a target host with a sorted alternative names using OpenAF
OpenAF	oJob.io	176	Parses ojob.io/news results into a clickable news title HMTL page.
OpenAF	oJob.io	177	Retrieves the list of oJob.io's jobs and filters which start by 'ojob.io/news' to display them in a rectangle
OpenAF	oPacks	178	Given a folder of expanded oPacks folders will process each folder .package.yaml file and join each corresponding oPack name and dependencies into a sinlge output map.
OpenAF	oPacks	179	Listing all currently accessible OpenAF's oPacks
OpenAF	oafp	180	Filter the OpenAF's oafp examples list by a specific word in the description
OpenAF	oafp	181	List the OpenAF's oafp examples by category, sub-category and description
OpenAF	oafp	182	Produce a colored table with all the current oafp input and output formats supported.
OpenVPN	List	183	When using the container nmaguiar/openvpn it's possible to convert the list of all clients order by expiration/end date
QR	Encode JSON	184	Given a JSON input encode and decote it from a QR-code png file.
QR	Read QR-code	185	Given a QR-code png file output the corresponding contents.
QR	URL	186	Generate a QR-code for a provided URL.
Unix	Activity	187	Uses the Linux command 'last' output to build a table with user, tty, from and period of activity for Debian based Linuxs
Unix	Activity	188	Uses the Linux command 'last' output to build a table with user, tty, from and period of activity for RedHat based Linuxs
Unix	Alpine	189	List all installed packages in an Alpine system
Unix	Ask	190	Unix bash script to ask for a path and choose between filetypes to perform an unix find command.
Unix	Compute	191	Parses the Linux /proc/cpuinfo into an array
Unix	Debian/Ubuntu	192	List all installed packages in a Debian/Ubuntu system
Unix	Envs	193	Converts the Linux envs command result into a table of environment variables and corresponding values
Unix	Files	194	Converting the Linux's /etc/os-release to SQL insert statements.
Unix	Files	195	Converting the Unix's syslog into a json output.
Unix	Files	196	Executes a recursive file list find command converting the result into a table.
Unix	Files	197	Parses the Linux /etc/passwd to a table order by uid and gid.
Unix	Generic	198	Creates, in unix, a data.ndjson file where each record is formatted from json files in /some/data
Unix	Memory map	199	Given an Unix process will output a table with process's components memory address, size in bytes, permissions and owner
Unix	Network	200	Loop over the current Linux active network connections
Unix	Network	201	Parse the Linux 'arp' command output
Unix	Network	202	Parse the Linux 'ip tcp_metrics' command
Unix	Network	203	Parse the result of the Linux route command
Unix	OpenSuse	204	List all installed packages in an OpenSuse system or zypper based system
Unix	RedHat	205	List all installed packages in a RedHat system or rpm based system (use rpm –querytags to list all fields available)
Unix	Storage	206	Converting the Unix's df output
Unix	Storage	207	Parses the result of the Unix ls command
Unix	SystemCtl	208	Converting the Unix's systemctl list-timers
Unix	SystemCtl	209	Converting the Unix's systemctl list-units
Unix	SystemCtl	210	Converting the Unix's systemctl list-units into an overview table
Unix	Threads	211	Given an unix process id (pid) loop a table with its top 25 most cpu active threads
Unix	UBI	212	List all installed packages in an UBI system
Unix	named	213	Converts a Linux's named log, for client queries, into a CSV
Unix	strace	214	Given a strace unix command will produce a summary table of the system calls invoked including a small line chart of the percentage of time of each.
VSCode	Extensions	215	Check a Visual Studio Code (vscode) extension (vsix) manifest.
Windows	Network	216	Output a table with the current route table using Windows' PowerShell
Windows	Network	217	Output a table with the list of network interfaces using Windows' PowerShell
Windows	PnP	218	Output a table with USB/PnP devices using Windows' PowerShell
Windows	Storage	219	Output a table with the attached disk information using Windows' PowerShell
XML	Maven	220	Given a Maven pom.xml parses the XML content to a colored table ordering by the fields groupId and artifactId.
nAttrMon	Plugs	221	Given a nAttrMon config folder, with YAML files, produce a summary table with the each plug (yaml file) execFrom definition.

📗 Examples

---

1

📖 AI | BedRock

List all AWS BedRock models available to use.

export OAFP_MODEL="(type: bedrock, options: ())"
oafp in=llmmodels out=ctable path="[].{id: modelId, arn: modelArn}" libs="@AWS/aws.js" data="()"

---

2

📖 AI | BedRock

Place a prompt to get a list of data using AWS BedRock titan express model.

# opack install AWS
export OAFP_MODEL="(type: bedrock, timeout: 900000, options: (model: 'amazon.titan-text-express-v1', temperature: 0, params: (textGenerationConfig: (maxTokenCount: 1024))))"
oafp in=llm libs="@AWS/aws.js" data="list of primary color names" getlist=true out=ctable

---

3

📖 AI | BedRock

Place a prompt to get a list of data using an AWS BedRock Llama model.

# opack install AWS
export OAFP_MODEL="(type: bedrock, timeout: 900000, options: (model: 'eu.meta.llama3-2-3b-instruct-v1:0', region: eu-central-1, temperature: 0.1, params: ('top_p': 0.9, 'max_gen_len': 512)))"
oafp in=llm libs="@AWS/aws.js" data="produce a list of european countries with the country name and capital" getlist=true out=ctable

---

4

📖 AI | BedRock

Using AWS BedRock Mistral model to place a prompt

# opack install AWS
export OAFP_MODEL="(type: bedrock, timeout: 900000, options: (model: 'mistral.mistral-7b-instruct-v0:2', region: eu-west-1, temperature: 0.7, params: ('top_p': 0.9, 'max_tokens': 8192)))"
oafp in=llm libs="@AWS/aws.js" data="why is the sky blue?" out=md path="outputs[0].text"

---

5

📖 AI | BedRock

Using AWS BedRock to place a prompt to an AWS Nova model to get an Unix command to find all javascript files older than 1 day

# opack install AWS
export OAFP_MODEL="(type: bedrock, timeout: 900000, options: (model: 'amazon.nova-micro-v1:0', temperature: 0))"
oafp in=llm libs="@AWS/aws.js" data="unix command to find all .js files older than 1 day" path=command

---

6

📖 AI | Classification

Given a list of news titles with corresponding dates and sources add a category and sub-category field to each

export OAFP_MODEL="(type: ollama, model: 'llama3', url: 'http://ollama.local', timeout: 900000, temperature: 0)"
# get 10 news titles
RSS="https://news.google.com/rss" && oafp url="$RSS" path="rss.channel.item[].{title:title,date:pubDate,source:source._}" from="sort(-date)" out=json sql="select * limit 5" > news.json
# add category and sub-category
oafp news.json llmcontext="list a news titles with date and source" llmprompt="keeping the provided title, date and source add a category and sub-category fields to the provided list" out=json > newsCategorized.json
oafp newsCategorized.json getlist=true out=ctable

---

7

📖 AI | Classification

Given the current news pipe the news title to an LLM model to add emoticons to each title.

# export OAFP_MODEL="(type: gemini, model: gemini-2.0-flash-thinking-exp, key: ..., timeout: 900000, temperature: 0)"
ojob ojob.io/news/bbc -json | oafp path="[].title|{title:@}" out=json | oafp llmcontext="news titles" llmprompt="add emojis to each news title" getlist=true out=ctable

---

8

📖 AI | Classification

Using Google's Gemini model and a list of jar files will try to produce a table categorizing and describing the function of each jar file.

# export OAFP_MODEL=(type: gemini, model: gemini-1.5-flash, key: '...', timeout: 900000, temperature: 0)
oafp in=ls data=lib path="[?ends_with(filename,'.jar')].filename" llmcontext="jar list" llmprompt="add a 'category', 'subcategory' and 'description' to each listed jar file" getlist=true out=json | oafp sql="select * order by category, subcategory" out=ctable

---

9

📖 AI | Conversation

Send multiple requests to an OpenAI model keeping the conversation between interactions and setting the temperature parameter

export OAFP_MODEL="(type: openai, model: 'gpt-3.5-turbo-0125', key: ..., timeout: 900000, temperature: 0)"
echo "List all countries in the european union" | oafp in=llm out=ctree llmconversation=cvst.json
echo "Add the corresponding country capital" | oafp in=llm out=ctree llmconversation=cvst.json
rm cvst.json

---

10

📖 AI | DeepSeek

Given a list of files and their corresponding sizes use DeepSeek R1 model to produce a list of 5 files that would be interesting to use to test an ETL tool.

# export OAFP_MODEL="(type: ollama, model: 'deepseek-r1:8b', url: 'https://ollama.local', timeout: 10000000, temperature: 0)"
oafp in=ls data="." path="[].{path:canonicalPath,size:size}" llmcontext="list of local files with path and size" llmprompt="output a json array with the suggestion of 5 data files that would be interesting to use to test an ETL tool" getlist=true out=ctable

---

11

📖 AI | Evaluate

Given a strace summary of the execution of a command (CMD) use a LLM to describe a reason on the results obtained.

export OAFP_MODEL="(type: openai, model: 'gpt-4o-mini', timeout: 900000, temperature: 0)"
CMD="strace --tips" && strace -c -o /tmp/result.txt $CMD ; cat /tmp/result.txt ; oafp /tmp/result.txt in=raw llmcontext="strace execution json summary" llmprompt="given the provided strace execution summary produce a table-based analysis with a small description of each system call and a bullet point conclusion summary" out=md ; rm /tmp/result.txt

---

12

📖 AI | Gemini

Use Google's Gemini LLM model together with Google Search to obtain the current top 10 news titles around the world

# export OAFP_MODEL="(type: gemini, model: gemini-2.5-flash-preview-05-20, key: ..., timeout: 900000, temperature: 0, params: (tools: [(googleSearch: ())]))"
oafp in=llm data="produce me a json list of the current top 10 news titles around the world" out=ctable getlist=true

---

13

📖 AI | Generate data

Generates synthetic data making parallel prompts to a LLM model and then cleaning up the result removing duplicate records into a final csv file.

# Set the LLM model to use
export OAFP_MODEL="(type: openai, url: 'https://api.scaleway.ai', key: '111-222-333', model: 'llama-3.1-70b-instruct', headers: (Content-Type: application/json))"
# Run 5 parallel prompts to generate data
oafp data="()" path="range(\`5\`)" out=cmd outcmdtmpl=true outcmd="oafp data='generate a list of 10 maps each with firstName, lastName, city and country' in=llm out=ndjson" > data.ndjson
# Clean-up generate data removing duplicates
oafp data.ndjson in=ndjson ndjsonjoin=true removedups=true out=csv > data.csv

---

14

📖 AI | Generate data

Generates synthetic data using a LLM model and then uses the recorded conversation to generate more data respecting the provided instructions

export OAFP_MODEL="(type: ollama, model: 'llama3', url: 'https://models.local', timeout: 900000)"
oafp in=llm llmconversation=conversation.json data="Generate #5 synthetic transaction record data with the following attributes: transaction id - a unique alphanumeric code; date - a date in YYYY-MM-DD format; amount - a dollar amount between 10 and 1000; description - a brief description of the transaction" getlist=true out=ndjson > data.ndjson
oafp in=llm llmconversation=conversation.json data="Generate 5 more records" getlist=true out=ndjson >> data.ndjson
oafp data.ndjson ndjsonjoin=true out=ctable sql="select * order by transaction_id"

---

15

📖 AI | GitHub models

Basic example to use GitHub Models inference with oafp

# export OAFP_MODEL="(type: openai, url: 'https://models.github.ai/inference', model: openai/gpt-4.1-nano, key: $(gh auth token), timeout: 900000, temperature: 0, apiVersion: '')"
oafp in=llm data="say hi to me"

---

16

📖 AI | Groq

Calculation

export OAFP_MODEL="(type: openai, model: 'llama3-70b-8192', key: '...', url: 'https://api.groq.com/openai', timeout: 900000, temperature: 0)"
oafp in=llm data="how much does light take to travel from Tokyo to Osaka in ms; return a 'time_in_ms' and a 'reasoning'"

---

17

📖 AI | Mistral

List all available LLM models at mistral.ai

# export OAFP_MODEL="(type: openai, model: 'llama3', url: 'https://api.mistral.ai', key: '...', timeout: 900000, temperature: 0)"
oafp in=llmmodels data="()" path="sort([].id)"

---

18

📖 AI | Ollama

Given the current list of Ollama models will try to pull each one of them in parallel

ollama list | oafp in=lines linesvisual=true linesjoin=true opath="[].NAME" out=json | oafp out=cmd outcmd="ollama pull {}" outcmdparam=true

---

19

📖 AI | Ollama

Setting up access to Ollama and ask for data to an AI LLM model

export OAFP_MODEL="(type: ollama, model: 'mistral', url: 'https://models.local', timeout: 900000)"
echo "Output a JSON array with 15 cities where each entry has the 'city' name, the estimated population and the corresponding 'country'" | oafp input=llm output=json > data.json
oafp data.json output=ctable sql="select * order by population desc"

---

20

📖 AI | OpenAI

Setting up the OpenAI LLM model and gather the data into a data.json file

export OAFP_MODEL="(type: openai, model: gpt-3.5-turbo, key: ..., timeout: 900000)"
echo "list all United Nations secretaries with their corresponding 'name', their mandate 'begin date', their mandate 'end date' and their corresponding secretary 'numeral'" | oafp input=llm output=json > data.json

---

21

📖 AI | Perplexity

Basic example to use Perplexity AI API with oafp

# export OAFP_MODEL="(type: openai, model: sonar, key: ..., url: 'https://api.perplexity.ai', timeout: 900000, temperature: 0, noSystem: false, noResponseFormat: true, apiVersion: '')"
oafp in=llm data="Say hi to me"

---

22

📖 AI | Prompt

Example of generating data from an AI LLM prompt

export OAFP_MODEL="(type: openai, model: 'gpt-3.5-turbo', key: '...', timeout: 900000)"
oafp in=llm data="produce a list of 25 species of 'flowers' with their english and latin name and the continent where it can be found" out=json > data.json

---

23

📖 AI | Scaleway

Setting up a Scaleway Generative API LLM connection and ask for a list of all Roman emperors.

OAFP_MODEL="(type: openai, url: 'https://api.scaleway.ai', key: '111-222-333', model: 'llama-3.1-70b-instruct', headers: (Content-Type: application/json))"
oafp data="list all roman emperors" in=llm getlist=true out=ctable

---

24

📖 AI | Summarize

Use an AI LLM model to summarize the weather information provided in a JSON format

export OAFP_MODEL="(type: openai, model: 'gpt-3.5-turbo', key: '...', timeout: 900000)"
oafp url="https://wttr.in?format=j2" llmcontext="current and forecast weather" llmprompt="produce a summary of the current and forecasted weather" out=md

---

25

📖 AI | Template

Convert oAFp llmconversation JSON file into a HTML of the LLM conversation

oafp conversation.json out=template templatetmpl=true template="**: 

<!DOCTYPE html>

<html lang="en-US">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=Edge">

  <link rel="stylesheet" href="/assets/css/just-the-docs-default.css">

  <link rel="stylesheet" href="/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet">

  <style id="jtd-nav-activation">
  

    .site-nav > ul.nav-list:first-child > li > a,
    .site-nav > ul.nav-list:first-child > li > ul > li > a,
    .site-nav > ul.nav-list:first-child > li > ul > li > ul > li > a,
    
    .site-nav > ul.nav-list:first-child > li > ul > li > ul > li > ul > li:not(:nth-child(5)) > a,
    .site-nav > ul.nav-list:first-child > li > ul > li > ul > li > ul > li > ul > li a {
      background-image: none;
    }

    .site-nav > ul.nav-list:not(:first-child) a,
    .site-nav li.external a {
      background-image: none;
    }

    .site-nav > ul.nav-list:first-child > li:nth-child(1) > ul > li:nth-child(2) > ul > li:nth-child(6) > ul > li:nth-child(5) > a {
      font-weight: 600;
      text-decoration: none;
    }.site-nav > ul.nav-list:first-child > li:nth-child(1) > button svg,
    .site-nav > ul.nav-list:first-child > li:nth-child(1) > ul > li:nth-child(2) > button svg,
    .site-nav > ul.nav-list:first-child > li:nth-child(1) > ul > li:nth-child(2) > ul > li:nth-child(6) > button svg,
    .site-nav > ul.nav-list:first-child > li:nth-child(1) > ul > li:nth-child(2) > ul > li:nth-child(6) > ul > li:nth-child(5) > button svg {
      transform: rotate(-90deg);
    }.site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(1) > ul.nav-list,
    .site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(1) > ul.nav-list > li.nav-list-item:nth-child(2) > ul.nav-list,
    .site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(1) > ul.nav-list > li.nav-list-item:nth-child(2) > ul.nav-list > li.nav-list-item:nth-child(6) > ul.nav-list,
    .site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(1) > ul.nav-list > li.nav-list-item:nth-child(2) > ul.nav-list > li.nav-list-item:nth-child(6) > ul.nav-list > li.nav-list-item:nth-child(5) > ul.nav-list {
      display: block;
    }
  </style>

  
    
    <script async src="https://www.googletagmanager.com/gtag/js?id=G-VC702B2LH6"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());

      
        gtag('config', 'G-VC702B2LH6', { 'anonymize_ip': true });
      
    </script>
  

  
    <script src="/assets/js/vendor/lunr.min.js"></script>
  

  <script src="/assets/js/just-the-docs.js"></script>

  <meta name="viewport" content="width=device-width, initial-scale=1">

  

  <link rel="icon" href="/images/openaf.ico%22" type="image/x-icon">



  <!-- Begin Jekyll SEO tag v2.8.0 -->
<title>oafp basic examples | OpenAF docs</title>
<meta name="generator" content="Jekyll v3.10.0" />
<meta property="og:title" content="oafp basic examples" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="OpenAF guides, concepts and how-tos documentation." />
<meta property="og:description" content="OpenAF guides, concepts and how-tos documentation." />
<link rel="canonical" href="https://docs.openaf.io/docs/guides/oafp/oafp-basic-examples.html" />
<meta property="og:url" content="https://docs.openaf.io/docs/guides/oafp/oafp-basic-examples.html" />
<meta property="og:site_name" content="OpenAF docs" />
<meta property="og:type" content="website" />
<meta name="twitter:card" content="summary" />
<meta property="twitter:title" content="oafp basic examples" />
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"WebPage","description":"OpenAF guides, concepts and how-tos documentation.","headline":"oafp basic examples","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://docs.openaf.io/images/openaf_logo.png"}},"url":"https://docs.openaf.io/docs/guides/oafp/oafp-basic-examples.html"}</script>
<!-- End Jekyll SEO tag -->


  

</head>

<body>
  <a class="skip-to-main" href="#main-content">Skip to main content</a>
  <svg xmlns="http://www.w3.org/2000/svg" class="d-none">
  <symbol id="svg-link" viewBox="0 0 24 24">
  <title>Link</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link">
    <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path>
  </svg>
</symbol>

  <symbol id="svg-menu" viewBox="0 0 24 24">
  <title>Menu</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu">
    <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line>
  </svg>
</symbol>

  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
  <title>Expand</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right">
    <polyline points="9 18 15 12 9 6"></polyline>
  </svg>
</symbol>

  <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE -->
<symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link">
  <title id="svg-external-link-title">(external link)</title>
  <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line>
</symbol>

  
    <symbol id="svg-doc" viewBox="0 0 24 24">
  <title>Document</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file">
    <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline>
  </svg>
</symbol>

    <symbol id="svg-search" viewBox="0 0 24 24">
  <title>Search</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search">
    <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line>
  </svg>
</symbol>

  
  
    <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md -->
<symbol id="svg-copy" viewBox="0 0 16 16">
  <title>Copy</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16">
    <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/>
    <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/>
  </svg>
</symbol>
<symbol id="svg-copied" viewBox="0 0 16 16">
  <title>Copied</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16">
    <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/>
    <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/>
  </svg>
</symbol>

  
</svg>

  
    <div class="side-bar">
  <div class="site-header" role="banner">
    <a href="/" class="site-title lh-tight">
  <div class="site-logo" role="img" aria-label="OpenAF docs"></div>

</a>
    <button id="menu-button" class="site-button btn-reset" aria-label="Toggle menu" aria-pressed="false">
      <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg>
    </button>
  </div>

  <nav aria-label="Main" id="site-nav" class="site-nav">
  
  
    <ul class="nav-list"><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in OpenAF docs category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/" class="nav-list-link">OpenAF docs</a><ul class="nav-list"><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Concepts category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/concepts/" class="nav-list-link">Concepts</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/concepts/OpenAF-cache.html" class="nav-list-link">$cache</a></li><li class="nav-list-item"><a href="/docs/concepts/OpenAF-nLinq.html" class="nav-list-link">$from</a></li><li class="nav-list-item"><a href="/docs/concepts/OpenAF-path.html" class="nav-list-link">$path</a></li><li class="nav-list-item"><a href="/docs/concepts/java.html" class="nav-list-link">Java support</a></li><li class="nav-list-item"><a href="/docs/concepts/javascript2oaf.html" class="nav-list-link">Javascript to OpenAF</a></li><li class="nav-list-item"><a href="/docs/concepts/openaf.html" class="nav-list-link">OpenAF</a></li><li class="nav-list-item"><a href="/docs/concepts/OpenAF-Channels.html" class="nav-list-link">OpenAF Channels</a></li><li class="nav-list-item"><a href="/docs/concepts/container-images.html" class="nav-list-link">OpenAF container images</a></li><li class="nav-list-item"><a href="/docs/concepts/sBuckets.html" class="nav-list-link">SBuckets</a></li><li class="nav-list-item"><a href="/docs/concepts/shebang.html" class="nav-list-link">Shebang</a></li><li class="nav-list-item"><a href="/docs/concepts/static-installation.html" class="nav-list-link">Static installation</a></li><li class="nav-list-item"><a href="/docs/concepts/oJob.html" class="nav-list-link">oJob</a></li><li class="nav-list-item"><a href="/docs/concepts/oJobIO.html" class="nav-list-link">oJob.io</a></li><li class="nav-list-item"><a href="/docs/concepts/oPack.html" class="nav-list-link">oPack</a></li><li class="nav-list-item"><a href="/docs/concepts/OpenAF-oPromise.html" class="nav-list-link">oPromise</a></li><li class="nav-list-item"><a href="/docs/concepts/oafp.html" class="nav-list-link">oafp</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Guides category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/guides/" class="nav-list-link">Guides</a><ul class="nav-list"><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in cheat-sheet category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/guides/cheat-sheet/" class="nav-list-link">cheat-sheet</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/csv-shortcuts.html" class="nav-list-link">$csv shortcuts</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/from.html" class="nav-list-link">$from()</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/sh-shortcuts.html" class="nav-list-link">$sh shortcuts</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/oaf-flags.html" class="nav-list-link">OpenAF flags</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/openaf-programming.html" class="nav-list-link">OpenAF programming quick-guide</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/string-formatter.html" class="nav-list-link">String formatter</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/templating.html" class="nav-list-link">Templating</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/test-connectivity.html" class="nav-list-link">Test connectivity</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/ojob-langs.html" class="nav-list-link">oJob langs</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/ojob-all.html" class="nav-list-link">oJob reference</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/ojob-shortcuts.html" class="nav-list-link">oJob shortcuts</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/ojob.io-s3.html" class="nav-list-link">ojob.io s3</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Beginner category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/guides/beginner/" class="nav-list-link">Beginner</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/guides/beginner/accessing-environment-variables.html" class="nav-list-link">Accessing environment variables</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/handling-spaces-in-keys-handlebars.html" class="nav-list-link">Accessing object keys with spaces in OpenAF templates (Handlebars)</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/adding-an-array-to-an-excel-spreadsheet.html" class="nav-list-link">Adding an array to an Excel spreadsheet</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/appending-to-files.html" class="nav-list-link">Appending to files</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/build-a-web-service-to-run-a-command.html" class="nav-list-link">Building a simple web-service to run a command-line</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/calling-db-stored-procedures.html" class="nav-list-link">Calling DB stored procedures</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/calling-an-aws-lambda-function.html" class="nav-list-link">Calling an AWS Lambda function</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/check-ssl-certificates.html" class="nav-list-link">Check SSL certificates</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/checking-arguments.html" class="nav-list-link">Checking arguments</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/comparing-maps-arrays.html" class="nav-list-link">Comparing maps and arrays</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/converting-array-to-csv-and-viceversa.html" class="nav-list-link">Converting an array to a CSV file and vice-versa</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/converting-numbers.html" class="nav-list-link">Converting numbers</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/creating-a-zip-file.html" class="nav-list-link">Creating a ZIP file</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/date-diff.html" class="nav-list-link">Date diff</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/date-to-from-string.html" class="nav-list-link">Date to/from string</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/encode-decode-base64.html" class="nav-list-link">Encode/Decode base64 in OpenAF</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/encrypt-decrypt-with-pubpriv-keys.html" class="nav-list-link">Encrypt/Decrypt with public/private keys</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/format-bytes-abbreviation.html" class="nav-list-link">Format bytes abbreviation</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/get-a-javascript-array-from-an-excel.html" class="nav-list-link">Get a javascript array from an Excel</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/converting-arrays-to-map-and-viceversa.html" class="nav-list-link">How to convert arrays to maps and vice-versa</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/how-to-use-the-smb-plugin.html" class="nav-list-link">How to upload/download files from a Window/SMB share folder</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/introduction-to-streams-in-openaf.html" class="nav-list-link">Introduction to streams in OpenAF</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/is-defined-or-undefined.html" class="nav-list-link">Is defined or undefined</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/limit-memory.html" class="nav-list-link">Limit OpenAF memory</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/log-to-json.html" class="nav-list-link">Log to JSON</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/making-rest-calls.html" class="nav-list-link">Making REST service calls from OpenAF</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/making-it-easy-to-read-with-from.html" class="nav-list-link">Making it easy to read with $from</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/micro-remote-http-server-file-browser.html" class="nav-list-link">Micro remote HTTP server file browser</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/performing-cartesian-intersection-except.html" class="nav-list-link">Performing cartesian product, intersection and except over two arrays</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/prefer-ipv6-over-ipv4.html" class="nav-list-link">Prefer IPv6 over IPv4</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/protecting-system-exit.html" class="nav-list-link">Protecting from system exit</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/reading-writing-json-and-yaml.html" class="nav-list-link">Reading and writing from/to JSON and YAML files</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/receiving-keyboard-input.html" class="nav-list-link">Receiving keyboard input</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/relaxed-json-parser.html" class="nav-list-link">Relaxed JSON parser</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/testing-tcp-port.html" class="nav-list-link">Testing a TCP port</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/tmux-wierd-characters.html" class="nav-list-link">Tmux UTF-8 support</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/using-parallel4array.html" class="nav-list-link">Using the function parallel4Array</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/using-wildcards.html" class="nav-list-link">Using wildcards</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/gzip-in-openaf.html" class="nav-list-link">gzip/gunzip functionality in OpenAF</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/nattrmon-kill-after-x-amount-minutes.html" class="nav-list-link">nAttrMon kill after an amount of minutes</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/ojob-check-stall.html" class="nav-list-link">oJob Check for stall</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/ojob-ssh-basics.html" class="nav-list-link">oJob SSH Basics</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/ojob-exception-handling.html" class="nav-list-link">oJob exception handling</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Medium category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/guides/medium/" class="nav-list-link">Medium</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/guides/medium/accessing-get-set-in-python.html" class="nav-list-link">Accessing $get/$set in Python code blocks</a></li><li class="nav-list-item"><a href="/docs/guides/medium/accessing-mongodb.html" class="nav-list-link">Accessing MongoDB from OpenAF</a></li><li class="nav-list-item"><a href="/docs/guides/medium/accessing-xml-using-e4x.html" class="nav-list-link">Accessing XML using E4X</a></li><li class="nav-list-item"><a href="/docs/guides/medium/accessing-db-using-channel.html" class="nav-list-link">Accessing a database using an OpenAF channel</a></li><li class="nav-list-item"><a href="/docs/guides/medium/adding-color-to-openaf-scripts.html" class="nav-list-link">Adding color to OpenAF scripts</a></li><li class="nav-list-item"><a href="/docs/guides/medium/applying-selectors-array.html" class="nav-list-link">Applying selectors to an array</a></li><li class="nav-list-item"><a href="/docs/guides/medium/casting-values-in-postgresql-and-h2-for-openaf.html" class="nav-list-link">Casting values in PostgreSQL and H2 for OpenAF</a></li><li class="nav-list-item"><a href="/docs/guides/medium/check-current-java-memory.html" class="nav-list-link">Check current OpenAF Java memory</a></li><li class="nav-list-item"><a href="/docs/guides/medium/check-if-an-email-address-is-valid-for-sending-emails.html" class="nav-list-link">Check if an email address is valid for sending emails</a></li><li class="nav-list-item"><a href="/docs/guides/medium/checking-digests.html" class="nav-list-link">Checking hash digests</a></li><li class="nav-list-item"><a href="/docs/guides/medium/converting-a-csv-column.html" class="nav-list-link">Converting a CSV column</a></li><li class="nav-list-item"><a href="/docs/guides/medium/elasticsearch-deleting-indexes.html" class="nav-list-link">Deleting ElasticSearch/OpenSearch indexes</a></li><li class="nav-list-item"><a href="/docs/guides/medium/executing-a-remote-ssh-command-in-background.html" class="nav-list-link">Executing a remote SSH command in background</a></li><li class="nav-list-item"><a href="/docs/guides/medium/executing-code-when-an-openaf-script-execution-is-terminated.html" class="nav-list-link">Executing code when an OpenAF script execution is terminated</a></li><li class="nav-list-item"><a href="/docs/guides/medium/executing-commands-remotely-via-ssh.html" class="nav-list-link">Executing commands remotely via SSH</a></li><li class="nav-list-item"><a href="/docs/guides/medium/function-profiling.html" class="nav-list-link">Function profiling</a></li><li class="nav-list-item"><a href="/docs/guides/medium/handling-ojob-deps-failure.html" class="nav-list-link">Handling oJob deps failure</a></li><li class="nav-list-item"><a href="/docs/guides/medium/accessing-remote-jmx-data.html" class="nav-list-link">How to access remote JMX data</a></li><li class="nav-list-item"><a href="/docs/guides/medium/how-to-run-openaf-code-from-shell-script.html" class="nav-list-link">How to run OpenAF code from shell script</a></li><li class="nav-list-item"><a href="/docs/guides/medium/how-to-use-openaf-from-notepad.html" class="nav-list-link">How to use OpenAF from Notepad++</a></li><li class="nav-list-item"><a href="/docs/guides/medium/increasing-the-history-size-for-openaf-console.html" class="nav-list-link">Increasing the history size for openaf-console</a></li><li class="nav-list-item"><a href="/docs/guides/medium/elasticsearch-listing-indexes.html" class="nav-list-link">Listing ElasticSearch/OpenSearch indexes</a></li><li class="nav-list-item"><a href="/docs/guides/medium/logging-to-log-files.html" class="nav-list-link">Logging to log files</a></li><li class="nav-list-item"><a href="/docs/guides/medium/modifying-xml-using-e4x.html" class="nav-list-link">Modifying XML using E4X</a></li><li class="nav-list-item"><a href="/docs/guides/medium/openaf-console-color-formatting.html" class="nav-list-link">OpenAF-console color formatting</a></li><li class="nav-list-item"><a href="/docs/guides/medium/quick-xml-to-from-json.html" class="nav-list-link">Quick XML to/from JSON conversion</a></li><li class="nav-list-item"><a href="/docs/guides/medium/reading-listing-writing-tar-files.html" class="nav-list-link">Reading, listing and writing TAR files</a></li><li class="nav-list-item"><a href="/docs/guides/medium/running-different-ojob-langs.html" class="nav-list-link">Running different oJob languages</a></li><li class="nav-list-item"><a href="/docs/guides/medium/search-keys-and-values.html" class="nav-list-link">Searching map keys and values</a></li><li class="nav-list-item"><a href="/docs/guides/medium/aws-sending-sqs.html" class="nav-list-link">Sending AWS SQS messages</a></li><li class="nav-list-item"><a href="/docs/guides/medium/sending-emails.html" class="nav-list-link">Sending emails</a></li><li class="nav-list-item"><a href="/docs/guides/medium/sending-emails-from-ojob.html" class="nav-list-link">Sending emails from oJob</a></li><li class="nav-list-item"><a href="/docs/guides/medium/setting-db-auto-commit.html" class="nav-list-link">Setting DB auto commit</a></li><li class="nav-list-item"><a href="/docs/guides/medium/simple-nattrmon-debugging.html" class="nav-list-link">Simple nAttrMon debugging</a></li><li class="nav-list-item"><a href="/docs/guides/medium/template-negative-number.html" class="nav-list-link">Template negative number</a></li><li class="nav-list-item"><a href="/docs/guides/medium/timing-executions-on-openaf-console.html" class="nav-list-link">Timing executions on OpenAF console</a></li><li class="nav-list-item"><a href="/docs/guides/medium/use-do-a2b.html" class="nav-list-link">Using $doA2B</a></li><li class="nav-list-item"><a href="/docs/guides/medium/using-elasticsearch-with-nattrmon.html" class="nav-list-link">Using ElasticSearch with nAttrMon</a></li><li class="nav-list-item"><a href="/docs/guides/medium/using-java-methods.html" class="nav-list-link">Using Java classes & methods</a></li><li class="nav-list-item"><a href="/docs/guides/medium/using-in-mem-db.html" class="nav-list-link">Using an in memory DB</a></li><li class="nav-list-item"><a href="/docs/guides/medium/using-channel-peers.html" class="nav-list-link">Using channel peers</a></li><li class="nav-list-item"><a href="/docs/guides/medium/using-console-inside-kubernetes.html" class="nav-list-link">Using console inside Kubernetes</a></li><li class="nav-list-item"><a href="/docs/guides/medium/using-the-openafs-svn-plugin.html" class="nav-list-link">Using the OpenAF&#x27;s SVN plugin</a></li><li class="nav-list-item"><a href="/docs/guides/medium/using-snmp-client.html" class="nav-list-link">Using the SNMP plugin</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Advanced category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/guides/advanced/" class="nav-list-link">Advanced</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/guides/advanced/dynamically-adding-a-custom-jdbc.html" class="nav-list-link">Dynamically adding a custom JDBC driver</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/easily-add-ssl-cert.html" class="nav-list-link">Easily add a SSL certificate to access an URL</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/executing-code-asynchronously.html" class="nav-list-link">Executing code asynchronously (promises)</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/generating-sql-with-openaf-templates.html" class="nav-list-link">Generating SQL with OpenAF templates</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/db-fields.html" class="nav-list-link">Getting a DB table columns/fields</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/handling-failure-on-rest-calls.html" class="nav-list-link">Handling failure on REST calls</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/connecting-directly-to-local-jvm-jmx.html" class="nav-list-link">How to connect directly to a local JVM via JMX</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/how-to-copy-clobs-between-databases.html" class="nav-list-link">How to copy CLOBs between two databases</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/quick-openaf-streams-conversion.html" class="nav-list-link">Quick OpenAF streams conversion</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/quick-rest-service.html" class="nav-list-link">Quickly build a REST service in OpenAF</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/setting-a-proxy.html" class="nav-list-link">Setting a proxy</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/using-elasticsearch.html" class="nav-list-link">Using ElasticSearch</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/thread-box.html" class="nav-list-link">Using OpenAF thread &quot;boxes&quot;</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/using-a-filter-map.html" class="nav-list-link">Using a filter map</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/using-buffers-in-nattrmon.html" class="nav-list-link">Using buffers in nAttrMon</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/nattrmon-multiple-plugs-one-file.html" class="nav-list-link">nAttrMon multiple plugs in one file</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in OneLiner category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/guides/oneliner/" class="nav-list-link">OneLiner</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/guides/oneliner/quickly-validate-a-yaml-file.html" class="nav-list-link">Quickly validate a YAML file</a></li><li class="nav-list-item"><a href="/docs/guides/oneliner/starting-a-http-file-browser.html" class="nav-list-link">Starting a HTTP file browser</a></li><li class="nav-list-item"><a href="/docs/guides/oneliner/test-latency.html" class="nav-list-link">Test latency</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in oafp category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/guides/oafp/" class="nav-list-link">oafp</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/guides/oafp/included-examples.html" class="nav-list-link">OpenAF processor examples</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/oafp-filters.html" class="nav-list-link">OpenAF processor filters</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/oafp-template.html" class="nav-list-link">OpenAF processor template</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/oafp-usage.html" class="nav-list-link">OpenAF processor usage</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/oafp-basic-examples.html" class="nav-list-link">oafp basic examples</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/oafp-examples.html" class="nav-list-link">oafp reference list of examples</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/to-excel.html" class="nav-list-link">oafp to Excel</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/grids.html" class="nav-list-link">oafp to build grids</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/manipulate-text.html" class="nav-list-link">oafp to manipulate text</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/parsing-unix-files.html" class="nav-list-link">oafp to parse Unix files</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/with-db.html" class="nav-list-link">oafp with DB</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/with-docker.html" class="nav-list-link">oafp with Docker commands</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/with-elasticsearch.html" class="nav-list-link">oafp with ElasticSearch</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/json-schemas.html" class="nav-list-link">oafp with JSON schemas</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/with-kubectl.html" class="nav-list-link">oafp with Kubectl</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/with-ollama.html" class="nav-list-link">oafp with Ollama</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/with-openaf.html" class="nav-list-link">oafp with OpenAF</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/with-oaf-ch.html" class="nav-list-link">oafp with OpenAF's channels</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/with-openai.html" class="nav-list-link">oafp with OpenAI</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/unix-commands.html" class="nav-list-link">oafp with Unix commands</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/with-windows.html" class="nav-list-link">oafp with Windows</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/external-apis.html" class="nav-list-link">oafp with external APIs</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in oJob category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/guides/ojob/" class="nav-list-link">oJob</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/guides/ojob/llm-shortcut.html" class="nav-list-link">Example of using the LLM oJob shortcut</a></li><li class="nav-list-item"><a href="/docs/guides/ojob/oafp-shortcut.html" class="nav-list-link">Example of using the oafp oJob shortcut</a></li><li class="nav-list-item"><a href="/docs/guides/ojob/accessing-args-in-langs.html" class="nav-list-link">How to access args in multiple languages</a></li><li class="nav-list-item"><a href="/docs/guides/ojob/common-browse-ecr.html" class="nav-list-link">oJob AWS ECR browse functionality</a></li><li class="nav-list-item"><a href="/docs/guides/ojob/common-browse-s3.html" class="nav-list-link">oJob S3 browse functionality</a></li><li class="nav-list-item"><a href="/docs/guides/ojob/ojob-building-blocks.html" class="nav-list-link">oJob building blocks</a></li><li class="nav-list-item"><a href="/docs/guides/ojob/common-browse.html" class="nav-list-link">oJob common browse functionality</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in oJobIO category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/guides/ojobio/" class="nav-list-link">oJobIO</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/guides/ojobio/templates-apply.html" class="nav-list-link">Applying Templates</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/check-tls.html" class="nav-list-link">Check current Java TLS</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/compress-a-multi-line-string.html" class="nav-list-link">Compress a multi-line string</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/db-drivers.html" class="nav-list-link">DB JDBC drivers</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/decode-k8s-secret.html" class="nav-list-link">Decode a Kubernetes secret</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/elasticsearch-import-export.html" class="nav-list-link">ElasticSearch Import/Export</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/generating-ssh-jobs.html" class="nav-list-link">Generating SSH oJobs</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/get-ojob.html" class="nav-list-link">How to copy a remote oJob</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/kube-node-img-management.html" class="nav-list-link">Kubernetes nodes image management</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/quickly_download_java.html" class="nav-list-link">Quickly download portable JDKs/JREs</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/testing-adding-certs-java.html" class="nav-list-link">Testing & adding SSL/TLS certificates to a Java keystore</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/shell-autocomplete.html" class="nav-list-link">Unix shell auto-complete</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/validate-yaml.html" class="nav-list-link">Validate an YAML file</a></li></ul></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in How To category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/howto/" class="nav-list-link">How To</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/howto/color-formats.html" class="nav-list-link">How To - Change color formats</a></li><li class="nav-list-item"><a href="/docs/howto/Download-older-versions.html" class="nav-list-link">How To - Download older versions</a></li><li class="nav-list-item"><a href="/docs/howto/Update-JVM-version.html" class="nav-list-link">How To - Update the JVM version</a></li><li class="nav-list-item"><a href="/docs/howto/Use-ask.html" class="nav-list-link">How To - Use ask functions</a></li><li class="nav-list-item"><a href="/docs/howto/Use-files.html" class="nav-list-link">How To - Use files</a></li><li class="nav-list-item"><a href="/docs/howto/Use-log.html" class="nav-list-link">How To - Use log functions</a></li><li class="nav-list-item"><a href="/docs/howto/Download-without-curl-or-wget.html" class="nav-list-link">How to - Download without curl or wget</a></li><li class="nav-list-item"><a href="/docs/howto/Installation-global-ojobs.html" class="nav-list-link">Installation global oJobs</a></li><li class="nav-list-item"><a href="/installing-nightly.html" class="nav-list-link">Installing the nightly build</a></li><li class="nav-list-item"><a href="/installing.html" class="nav-list-link">Specific installation instructions</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Reference category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/reference/" class="nav-list-link">Reference</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/reference/afbase.html" class="nav-list-link">afbase</a></li><li class="nav-list-item"><a href="/docs/reference/bsdiff.html" class="nav-list-link">bsdiff</a></li><li class="nav-list-item"><a href="/docs/reference/console.html" class="nav-list-link">console</a></li><li class="nav-list-item"><a href="/docs/reference/csv.html" class="nav-list-link">csv</a></li><li class="nav-list-item"><a href="/docs/reference/db.html" class="nav-list-link">db</a></li><li class="nav-list-item"><a href="/docs/reference/email.html" class="nav-list-link">email</a></li><li class="nav-list-item"><a href="/docs/reference/http.html" class="nav-list-link">http</a></li><li class="nav-list-item"><a href="/docs/reference/httpd.html" class="nav-list-link">httpd</a></li><li class="nav-list-item"><a href="/docs/reference/iocore.html" class="nav-list-link">iocore</a></li><li class="nav-list-item"><a href="/docs/reference/jmx.html" class="nav-list-link">jmx</a></li><li class="nav-list-item"><a href="/docs/reference/jmxserver.html" class="nav-list-link">jmxserver</a></li><li class="nav-list-item"><a href="/docs/reference/ojob.html" class="nav-list-link">oJob Reference Guide</a></li><li class="nav-list-item"><a href="/docs/reference/odoc.html" class="nav-list-link">odoc</a></li><li class="nav-list-item"><a href="/docs/reference/ow_ai.html" class="nav-list-link">ow.ai</a></li><li class="nav-list-item"><a href="/docs/reference/ow_ch.html" class="nav-list-link">ow.ch</a></li><li class="nav-list-item"><a href="/docs/reference/ow_debug.html" class="nav-list-link">ow.debug</a></li><li class="nav-list-item"><a href="/docs/reference/ow_format.html" class="nav-list-link">ow.format</a></li><li class="nav-list-item"><a href="/docs/reference/ow_java.html" class="nav-list-link">ow.java</a></li><li class="nav-list-item"><a href="/docs/reference/ow_metrics.html" class="nav-list-link">ow.metrics</a></li><li class="nav-list-item"><a href="/docs/reference/ow_net.html" class="nav-list-link">ow.net</a></li><li class="nav-list-item"><a href="/docs/reference/ow_oJob.html" class="nav-list-link">ow.oJob</a></li><li class="nav-list-item"><a href="/docs/reference/ow_obj.html" class="nav-list-link">ow.obj</a></li><li class="nav-list-item"><a href="/docs/reference/ow_python.html" class="nav-list-link">ow.python</a></li><li class="nav-list-item"><a href="/docs/reference/ow_sec.html" class="nav-list-link">ow.sec</a></li><li class="nav-list-item"><a href="/docs/reference/ow_server.html" class="nav-list-link">ow.server</a></li><li class="nav-list-item"><a href="/docs/reference/ow_template.html" class="nav-list-link">ow.template</a></li><li class="nav-list-item"><a href="/docs/reference/ow_test.html" class="nav-list-link">ow.test</a></li><li class="nav-list-item"><a href="/docs/reference/scope.html" class="nav-list-link">scope</a></li><li class="nav-list-item"><a href="/docs/reference/scopesigil.html" class="nav-list-link">scopesigil</a></li><li class="nav-list-item"><a href="/docs/reference/snmp.html" class="nav-list-link">snmp</a></li><li class="nav-list-item"><a href="/docs/reference/snmpd.html" class="nav-list-link">snmpd</a></li><li class="nav-list-item"><a href="/docs/reference/ssh.html" class="nav-list-link">ssh</a></li><li class="nav-list-item"><a href="/docs/reference/threads.html" class="nav-list-link">threads</a></li><li class="nav-list-item"><a href="/docs/reference/xml.html" class="nav-list-link">xml</a></li><li class="nav-list-item"><a href="/docs/reference/zip.html" class="nav-list-link">zip</a></li></ul></li></ul></li></ul>
  
</nav>




  
  
    <footer class="site-footer">
      This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
    </footer>
  
</div>

  
  <div class="main" id="top">
    <div id="main-header" class="main-header">
  
    

<div class="search" role="search">
  <div class="search-input-wrap">
    <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search OpenAF docs" aria-label="Search OpenAF docs" autocomplete="off">
    <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label>
  </div>
  <div id="search-results" class="search-results"></div>
</div>

  
  
  
</div>

    <div class="main-content-wrap">
      <nav aria-label="Breadcrumb" class="breadcrumb-nav">
  <ol class="breadcrumb-nav-list">
    <li class="breadcrumb-nav-list-item"><a href="/">OpenAF docs</a></li>
    <li class="breadcrumb-nav-list-item"><a href="/docs/guides/">Guides</a></li>
    <li class="breadcrumb-nav-list-item"><a href="/docs/guides/oafp/">oafp</a></li>
    <li class="breadcrumb-nav-list-item"><span>oafp basic examples</span></li>
  </ol>
</nav>


      <div id="main-content" class="main-content">
        <main>
          
            <h1 id="oafp-basic-examples">
  
  
    <a href="#oafp-basic-examples" class="anchor-heading" aria-labelledby="oafp-basic-examples"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> oafp basic examples
  
  
</h1>
    
<h2 id="simple-format-conversions">
  
  
    <a href="#simple-format-conversions" class="anchor-heading" aria-labelledby="simple-format-conversions"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Simple format conversions
  
  
</h2>
    

<div class="table-wrapper"><table>
  <thead>
    <tr>
      <th>Description</th>
      <th>Example</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>Convert JSON to YAML</td>
      <td><code class="language-plaintext highlighter-rouge">oafp a-json-file.json out=yaml</code></td>
    </tr>
    <tr>
      <td>Convert YAML to JSON</td>
      <td><code class="language-plaintext highlighter-rouge">oafp a-yaml-file.yaml out=json</code></td>
    </tr>
    <tr>
      <td>Convert YAML to pretty JSON</td>
      <td><code class="language-plaintext highlighter-rouge">oafp a-yaml-file.yaml out=pjson</code></td>
    </tr>
    <tr>
      <td>Convert a NDJSON to a single JSON</td>
      <td><code class="language-plaintext highlighter-rouge">oafp a-ndjson.ndjson in=ndjson ndjsonjoin=true out=json</code></td>
    </tr>
    <tr>
      <td>Convert a JSON array to a multiple document YAML</td>
      <td><code class="language-plaintext highlighter-rouge">oafp a-json-array.json out=mdyaml</code></td>
    </tr>
  </tbody>
</table></div>

          

          
            
          
        </main>
        


      </div>
    </div>
    
      

<div class="search-overlay"></div>

    
  </div>

  
</body>
</html>

}\n\n---\n" | oafp in=md out=html htmlopen=false > conversation.html

---

26

📖 AI | Template

Convert oAFp llmconversation JSON file into a terminal readable template of the LLM conversation

oafp conversation.json out=template templatetmpl=true template="**: 

<!DOCTYPE html>

<html lang="en-US">
<head>
  <meta charset="UTF-8">
  <meta http-equiv="X-UA-Compatible" content="IE=Edge">

  <link rel="stylesheet" href="/assets/css/just-the-docs-default.css">

  <link rel="stylesheet" href="/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet">

  <style id="jtd-nav-activation">
  

    .site-nav > ul.nav-list:first-child > li > a,
    .site-nav > ul.nav-list:first-child > li > ul > li > a,
    .site-nav > ul.nav-list:first-child > li > ul > li > ul > li > a,
    
    .site-nav > ul.nav-list:first-child > li > ul > li > ul > li > ul > li:not(:nth-child(5)) > a,
    .site-nav > ul.nav-list:first-child > li > ul > li > ul > li > ul > li > ul > li a {
      background-image: none;
    }

    .site-nav > ul.nav-list:not(:first-child) a,
    .site-nav li.external a {
      background-image: none;
    }

    .site-nav > ul.nav-list:first-child > li:nth-child(1) > ul > li:nth-child(2) > ul > li:nth-child(6) > ul > li:nth-child(5) > a {
      font-weight: 600;
      text-decoration: none;
    }.site-nav > ul.nav-list:first-child > li:nth-child(1) > button svg,
    .site-nav > ul.nav-list:first-child > li:nth-child(1) > ul > li:nth-child(2) > button svg,
    .site-nav > ul.nav-list:first-child > li:nth-child(1) > ul > li:nth-child(2) > ul > li:nth-child(6) > button svg,
    .site-nav > ul.nav-list:first-child > li:nth-child(1) > ul > li:nth-child(2) > ul > li:nth-child(6) > ul > li:nth-child(5) > button svg {
      transform: rotate(-90deg);
    }.site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(1) > ul.nav-list,
    .site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(1) > ul.nav-list > li.nav-list-item:nth-child(2) > ul.nav-list,
    .site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(1) > ul.nav-list > li.nav-list-item:nth-child(2) > ul.nav-list > li.nav-list-item:nth-child(6) > ul.nav-list,
    .site-nav > ul.nav-list:first-child > li.nav-list-item:nth-child(1) > ul.nav-list > li.nav-list-item:nth-child(2) > ul.nav-list > li.nav-list-item:nth-child(6) > ul.nav-list > li.nav-list-item:nth-child(5) > ul.nav-list {
      display: block;
    }
  </style>

  
    
    <script async src="https://www.googletagmanager.com/gtag/js?id=G-VC702B2LH6"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());

      
        gtag('config', 'G-VC702B2LH6', { 'anonymize_ip': true });
      
    </script>
  

  
    <script src="/assets/js/vendor/lunr.min.js"></script>
  

  <script src="/assets/js/just-the-docs.js"></script>

  <meta name="viewport" content="width=device-width, initial-scale=1">

  

  <link rel="icon" href="/images/openaf.ico%22" type="image/x-icon">



  <!-- Begin Jekyll SEO tag v2.8.0 -->
<title>oafp basic examples | OpenAF docs</title>
<meta name="generator" content="Jekyll v3.10.0" />
<meta property="og:title" content="oafp basic examples" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="OpenAF guides, concepts and how-tos documentation." />
<meta property="og:description" content="OpenAF guides, concepts and how-tos documentation." />
<link rel="canonical" href="https://docs.openaf.io/docs/guides/oafp/oafp-basic-examples.html" />
<meta property="og:url" content="https://docs.openaf.io/docs/guides/oafp/oafp-basic-examples.html" />
<meta property="og:site_name" content="OpenAF docs" />
<meta property="og:type" content="website" />
<meta name="twitter:card" content="summary" />
<meta property="twitter:title" content="oafp basic examples" />
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"WebPage","description":"OpenAF guides, concepts and how-tos documentation.","headline":"oafp basic examples","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://docs.openaf.io/images/openaf_logo.png"}},"url":"https://docs.openaf.io/docs/guides/oafp/oafp-basic-examples.html"}</script>
<!-- End Jekyll SEO tag -->


  

</head>

<body>
  <a class="skip-to-main" href="#main-content">Skip to main content</a>
  <svg xmlns="http://www.w3.org/2000/svg" class="d-none">
  <symbol id="svg-link" viewBox="0 0 24 24">
  <title>Link</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link">
    <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path>
  </svg>
</symbol>

  <symbol id="svg-menu" viewBox="0 0 24 24">
  <title>Menu</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-menu">
    <line x1="3" y1="12" x2="21" y2="12"></line><line x1="3" y1="6" x2="21" y2="6"></line><line x1="3" y1="18" x2="21" y2="18"></line>
  </svg>
</symbol>

  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
  <title>Expand</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right">
    <polyline points="9 18 15 12 9 6"></polyline>
  </svg>
</symbol>

  <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE -->
<symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link">
  <title id="svg-external-link-title">(external link)</title>
  <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line>
</symbol>

  
    <symbol id="svg-doc" viewBox="0 0 24 24">
  <title>Document</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file">
    <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline>
  </svg>
</symbol>

    <symbol id="svg-search" viewBox="0 0 24 24">
  <title>Search</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search">
    <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line>
  </svg>
</symbol>

  
  
    <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md -->
<symbol id="svg-copy" viewBox="0 0 16 16">
  <title>Copy</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16">
    <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/>
    <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/>
  </svg>
</symbol>
<symbol id="svg-copied" viewBox="0 0 16 16">
  <title>Copied</title>
  <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16">
    <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/>
    <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/>
  </svg>
</symbol>

  
</svg>

  
    <div class="side-bar">
  <div class="site-header" role="banner">
    <a href="/" class="site-title lh-tight">
  <div class="site-logo" role="img" aria-label="OpenAF docs"></div>

</a>
    <button id="menu-button" class="site-button btn-reset" aria-label="Toggle menu" aria-pressed="false">
      <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg>
    </button>
  </div>

  <nav aria-label="Main" id="site-nav" class="site-nav">
  
  
    <ul class="nav-list"><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in OpenAF docs category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/" class="nav-list-link">OpenAF docs</a><ul class="nav-list"><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Concepts category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/concepts/" class="nav-list-link">Concepts</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/concepts/OpenAF-cache.html" class="nav-list-link">$cache</a></li><li class="nav-list-item"><a href="/docs/concepts/OpenAF-nLinq.html" class="nav-list-link">$from</a></li><li class="nav-list-item"><a href="/docs/concepts/OpenAF-path.html" class="nav-list-link">$path</a></li><li class="nav-list-item"><a href="/docs/concepts/java.html" class="nav-list-link">Java support</a></li><li class="nav-list-item"><a href="/docs/concepts/javascript2oaf.html" class="nav-list-link">Javascript to OpenAF</a></li><li class="nav-list-item"><a href="/docs/concepts/openaf.html" class="nav-list-link">OpenAF</a></li><li class="nav-list-item"><a href="/docs/concepts/OpenAF-Channels.html" class="nav-list-link">OpenAF Channels</a></li><li class="nav-list-item"><a href="/docs/concepts/container-images.html" class="nav-list-link">OpenAF container images</a></li><li class="nav-list-item"><a href="/docs/concepts/sBuckets.html" class="nav-list-link">SBuckets</a></li><li class="nav-list-item"><a href="/docs/concepts/shebang.html" class="nav-list-link">Shebang</a></li><li class="nav-list-item"><a href="/docs/concepts/static-installation.html" class="nav-list-link">Static installation</a></li><li class="nav-list-item"><a href="/docs/concepts/oJob.html" class="nav-list-link">oJob</a></li><li class="nav-list-item"><a href="/docs/concepts/oJobIO.html" class="nav-list-link">oJob.io</a></li><li class="nav-list-item"><a href="/docs/concepts/oPack.html" class="nav-list-link">oPack</a></li><li class="nav-list-item"><a href="/docs/concepts/OpenAF-oPromise.html" class="nav-list-link">oPromise</a></li><li class="nav-list-item"><a href="/docs/concepts/oafp.html" class="nav-list-link">oafp</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Guides category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/guides/" class="nav-list-link">Guides</a><ul class="nav-list"><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in cheat-sheet category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/guides/cheat-sheet/" class="nav-list-link">cheat-sheet</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/csv-shortcuts.html" class="nav-list-link">$csv shortcuts</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/from.html" class="nav-list-link">$from()</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/sh-shortcuts.html" class="nav-list-link">$sh shortcuts</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/oaf-flags.html" class="nav-list-link">OpenAF flags</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/openaf-programming.html" class="nav-list-link">OpenAF programming quick-guide</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/string-formatter.html" class="nav-list-link">String formatter</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/templating.html" class="nav-list-link">Templating</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/test-connectivity.html" class="nav-list-link">Test connectivity</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/ojob-langs.html" class="nav-list-link">oJob langs</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/ojob-all.html" class="nav-list-link">oJob reference</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/ojob-shortcuts.html" class="nav-list-link">oJob shortcuts</a></li><li class="nav-list-item"><a href="/docs/guides/cheat-sheet/ojob.io-s3.html" class="nav-list-link">ojob.io s3</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Beginner category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/guides/beginner/" class="nav-list-link">Beginner</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/guides/beginner/accessing-environment-variables.html" class="nav-list-link">Accessing environment variables</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/handling-spaces-in-keys-handlebars.html" class="nav-list-link">Accessing object keys with spaces in OpenAF templates (Handlebars)</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/adding-an-array-to-an-excel-spreadsheet.html" class="nav-list-link">Adding an array to an Excel spreadsheet</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/appending-to-files.html" class="nav-list-link">Appending to files</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/build-a-web-service-to-run-a-command.html" class="nav-list-link">Building a simple web-service to run a command-line</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/calling-db-stored-procedures.html" class="nav-list-link">Calling DB stored procedures</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/calling-an-aws-lambda-function.html" class="nav-list-link">Calling an AWS Lambda function</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/check-ssl-certificates.html" class="nav-list-link">Check SSL certificates</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/checking-arguments.html" class="nav-list-link">Checking arguments</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/comparing-maps-arrays.html" class="nav-list-link">Comparing maps and arrays</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/converting-array-to-csv-and-viceversa.html" class="nav-list-link">Converting an array to a CSV file and vice-versa</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/converting-numbers.html" class="nav-list-link">Converting numbers</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/creating-a-zip-file.html" class="nav-list-link">Creating a ZIP file</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/date-diff.html" class="nav-list-link">Date diff</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/date-to-from-string.html" class="nav-list-link">Date to/from string</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/encode-decode-base64.html" class="nav-list-link">Encode/Decode base64 in OpenAF</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/encrypt-decrypt-with-pubpriv-keys.html" class="nav-list-link">Encrypt/Decrypt with public/private keys</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/format-bytes-abbreviation.html" class="nav-list-link">Format bytes abbreviation</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/get-a-javascript-array-from-an-excel.html" class="nav-list-link">Get a javascript array from an Excel</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/converting-arrays-to-map-and-viceversa.html" class="nav-list-link">How to convert arrays to maps and vice-versa</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/how-to-use-the-smb-plugin.html" class="nav-list-link">How to upload/download files from a Window/SMB share folder</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/introduction-to-streams-in-openaf.html" class="nav-list-link">Introduction to streams in OpenAF</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/is-defined-or-undefined.html" class="nav-list-link">Is defined or undefined</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/limit-memory.html" class="nav-list-link">Limit OpenAF memory</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/log-to-json.html" class="nav-list-link">Log to JSON</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/making-rest-calls.html" class="nav-list-link">Making REST service calls from OpenAF</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/making-it-easy-to-read-with-from.html" class="nav-list-link">Making it easy to read with $from</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/micro-remote-http-server-file-browser.html" class="nav-list-link">Micro remote HTTP server file browser</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/performing-cartesian-intersection-except.html" class="nav-list-link">Performing cartesian product, intersection and except over two arrays</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/prefer-ipv6-over-ipv4.html" class="nav-list-link">Prefer IPv6 over IPv4</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/protecting-system-exit.html" class="nav-list-link">Protecting from system exit</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/reading-writing-json-and-yaml.html" class="nav-list-link">Reading and writing from/to JSON and YAML files</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/receiving-keyboard-input.html" class="nav-list-link">Receiving keyboard input</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/relaxed-json-parser.html" class="nav-list-link">Relaxed JSON parser</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/testing-tcp-port.html" class="nav-list-link">Testing a TCP port</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/tmux-wierd-characters.html" class="nav-list-link">Tmux UTF-8 support</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/using-parallel4array.html" class="nav-list-link">Using the function parallel4Array</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/using-wildcards.html" class="nav-list-link">Using wildcards</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/gzip-in-openaf.html" class="nav-list-link">gzip/gunzip functionality in OpenAF</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/nattrmon-kill-after-x-amount-minutes.html" class="nav-list-link">nAttrMon kill after an amount of minutes</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/ojob-check-stall.html" class="nav-list-link">oJob Check for stall</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/ojob-ssh-basics.html" class="nav-list-link">oJob SSH Basics</a></li><li class="nav-list-item"><a href="/docs/guides/beginner/ojob-exception-handling.html" class="nav-list-link">oJob exception handling</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Medium category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/guides/medium/" class="nav-list-link">Medium</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/guides/medium/accessing-get-set-in-python.html" class="nav-list-link">Accessing $get/$set in Python code blocks</a></li><li class="nav-list-item"><a href="/docs/guides/medium/accessing-mongodb.html" class="nav-list-link">Accessing MongoDB from OpenAF</a></li><li class="nav-list-item"><a href="/docs/guides/medium/accessing-xml-using-e4x.html" class="nav-list-link">Accessing XML using E4X</a></li><li class="nav-list-item"><a href="/docs/guides/medium/accessing-db-using-channel.html" class="nav-list-link">Accessing a database using an OpenAF channel</a></li><li class="nav-list-item"><a href="/docs/guides/medium/adding-color-to-openaf-scripts.html" class="nav-list-link">Adding color to OpenAF scripts</a></li><li class="nav-list-item"><a href="/docs/guides/medium/applying-selectors-array.html" class="nav-list-link">Applying selectors to an array</a></li><li class="nav-list-item"><a href="/docs/guides/medium/casting-values-in-postgresql-and-h2-for-openaf.html" class="nav-list-link">Casting values in PostgreSQL and H2 for OpenAF</a></li><li class="nav-list-item"><a href="/docs/guides/medium/check-current-java-memory.html" class="nav-list-link">Check current OpenAF Java memory</a></li><li class="nav-list-item"><a href="/docs/guides/medium/check-if-an-email-address-is-valid-for-sending-emails.html" class="nav-list-link">Check if an email address is valid for sending emails</a></li><li class="nav-list-item"><a href="/docs/guides/medium/checking-digests.html" class="nav-list-link">Checking hash digests</a></li><li class="nav-list-item"><a href="/docs/guides/medium/converting-a-csv-column.html" class="nav-list-link">Converting a CSV column</a></li><li class="nav-list-item"><a href="/docs/guides/medium/elasticsearch-deleting-indexes.html" class="nav-list-link">Deleting ElasticSearch/OpenSearch indexes</a></li><li class="nav-list-item"><a href="/docs/guides/medium/executing-a-remote-ssh-command-in-background.html" class="nav-list-link">Executing a remote SSH command in background</a></li><li class="nav-list-item"><a href="/docs/guides/medium/executing-code-when-an-openaf-script-execution-is-terminated.html" class="nav-list-link">Executing code when an OpenAF script execution is terminated</a></li><li class="nav-list-item"><a href="/docs/guides/medium/executing-commands-remotely-via-ssh.html" class="nav-list-link">Executing commands remotely via SSH</a></li><li class="nav-list-item"><a href="/docs/guides/medium/function-profiling.html" class="nav-list-link">Function profiling</a></li><li class="nav-list-item"><a href="/docs/guides/medium/handling-ojob-deps-failure.html" class="nav-list-link">Handling oJob deps failure</a></li><li class="nav-list-item"><a href="/docs/guides/medium/accessing-remote-jmx-data.html" class="nav-list-link">How to access remote JMX data</a></li><li class="nav-list-item"><a href="/docs/guides/medium/how-to-run-openaf-code-from-shell-script.html" class="nav-list-link">How to run OpenAF code from shell script</a></li><li class="nav-list-item"><a href="/docs/guides/medium/how-to-use-openaf-from-notepad.html" class="nav-list-link">How to use OpenAF from Notepad++</a></li><li class="nav-list-item"><a href="/docs/guides/medium/increasing-the-history-size-for-openaf-console.html" class="nav-list-link">Increasing the history size for openaf-console</a></li><li class="nav-list-item"><a href="/docs/guides/medium/elasticsearch-listing-indexes.html" class="nav-list-link">Listing ElasticSearch/OpenSearch indexes</a></li><li class="nav-list-item"><a href="/docs/guides/medium/logging-to-log-files.html" class="nav-list-link">Logging to log files</a></li><li class="nav-list-item"><a href="/docs/guides/medium/modifying-xml-using-e4x.html" class="nav-list-link">Modifying XML using E4X</a></li><li class="nav-list-item"><a href="/docs/guides/medium/openaf-console-color-formatting.html" class="nav-list-link">OpenAF-console color formatting</a></li><li class="nav-list-item"><a href="/docs/guides/medium/quick-xml-to-from-json.html" class="nav-list-link">Quick XML to/from JSON conversion</a></li><li class="nav-list-item"><a href="/docs/guides/medium/reading-listing-writing-tar-files.html" class="nav-list-link">Reading, listing and writing TAR files</a></li><li class="nav-list-item"><a href="/docs/guides/medium/running-different-ojob-langs.html" class="nav-list-link">Running different oJob languages</a></li><li class="nav-list-item"><a href="/docs/guides/medium/search-keys-and-values.html" class="nav-list-link">Searching map keys and values</a></li><li class="nav-list-item"><a href="/docs/guides/medium/aws-sending-sqs.html" class="nav-list-link">Sending AWS SQS messages</a></li><li class="nav-list-item"><a href="/docs/guides/medium/sending-emails.html" class="nav-list-link">Sending emails</a></li><li class="nav-list-item"><a href="/docs/guides/medium/sending-emails-from-ojob.html" class="nav-list-link">Sending emails from oJob</a></li><li class="nav-list-item"><a href="/docs/guides/medium/setting-db-auto-commit.html" class="nav-list-link">Setting DB auto commit</a></li><li class="nav-list-item"><a href="/docs/guides/medium/simple-nattrmon-debugging.html" class="nav-list-link">Simple nAttrMon debugging</a></li><li class="nav-list-item"><a href="/docs/guides/medium/template-negative-number.html" class="nav-list-link">Template negative number</a></li><li class="nav-list-item"><a href="/docs/guides/medium/timing-executions-on-openaf-console.html" class="nav-list-link">Timing executions on OpenAF console</a></li><li class="nav-list-item"><a href="/docs/guides/medium/use-do-a2b.html" class="nav-list-link">Using $doA2B</a></li><li class="nav-list-item"><a href="/docs/guides/medium/using-elasticsearch-with-nattrmon.html" class="nav-list-link">Using ElasticSearch with nAttrMon</a></li><li class="nav-list-item"><a href="/docs/guides/medium/using-java-methods.html" class="nav-list-link">Using Java classes & methods</a></li><li class="nav-list-item"><a href="/docs/guides/medium/using-in-mem-db.html" class="nav-list-link">Using an in memory DB</a></li><li class="nav-list-item"><a href="/docs/guides/medium/using-channel-peers.html" class="nav-list-link">Using channel peers</a></li><li class="nav-list-item"><a href="/docs/guides/medium/using-console-inside-kubernetes.html" class="nav-list-link">Using console inside Kubernetes</a></li><li class="nav-list-item"><a href="/docs/guides/medium/using-the-openafs-svn-plugin.html" class="nav-list-link">Using the OpenAF&#x27;s SVN plugin</a></li><li class="nav-list-item"><a href="/docs/guides/medium/using-snmp-client.html" class="nav-list-link">Using the SNMP plugin</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Advanced category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/guides/advanced/" class="nav-list-link">Advanced</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/guides/advanced/dynamically-adding-a-custom-jdbc.html" class="nav-list-link">Dynamically adding a custom JDBC driver</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/easily-add-ssl-cert.html" class="nav-list-link">Easily add a SSL certificate to access an URL</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/executing-code-asynchronously.html" class="nav-list-link">Executing code asynchronously (promises)</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/generating-sql-with-openaf-templates.html" class="nav-list-link">Generating SQL with OpenAF templates</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/db-fields.html" class="nav-list-link">Getting a DB table columns/fields</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/handling-failure-on-rest-calls.html" class="nav-list-link">Handling failure on REST calls</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/connecting-directly-to-local-jvm-jmx.html" class="nav-list-link">How to connect directly to a local JVM via JMX</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/how-to-copy-clobs-between-databases.html" class="nav-list-link">How to copy CLOBs between two databases</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/quick-openaf-streams-conversion.html" class="nav-list-link">Quick OpenAF streams conversion</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/quick-rest-service.html" class="nav-list-link">Quickly build a REST service in OpenAF</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/setting-a-proxy.html" class="nav-list-link">Setting a proxy</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/using-elasticsearch.html" class="nav-list-link">Using ElasticSearch</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/thread-box.html" class="nav-list-link">Using OpenAF thread &quot;boxes&quot;</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/using-a-filter-map.html" class="nav-list-link">Using a filter map</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/using-buffers-in-nattrmon.html" class="nav-list-link">Using buffers in nAttrMon</a></li><li class="nav-list-item"><a href="/docs/guides/advanced/nattrmon-multiple-plugs-one-file.html" class="nav-list-link">nAttrMon multiple plugs in one file</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in OneLiner category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/guides/oneliner/" class="nav-list-link">OneLiner</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/guides/oneliner/quickly-validate-a-yaml-file.html" class="nav-list-link">Quickly validate a YAML file</a></li><li class="nav-list-item"><a href="/docs/guides/oneliner/starting-a-http-file-browser.html" class="nav-list-link">Starting a HTTP file browser</a></li><li class="nav-list-item"><a href="/docs/guides/oneliner/test-latency.html" class="nav-list-link">Test latency</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in oafp category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/guides/oafp/" class="nav-list-link">oafp</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/guides/oafp/included-examples.html" class="nav-list-link">OpenAF processor examples</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/oafp-filters.html" class="nav-list-link">OpenAF processor filters</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/oafp-template.html" class="nav-list-link">OpenAF processor template</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/oafp-usage.html" class="nav-list-link">OpenAF processor usage</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/oafp-basic-examples.html" class="nav-list-link">oafp basic examples</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/oafp-examples.html" class="nav-list-link">oafp reference list of examples</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/to-excel.html" class="nav-list-link">oafp to Excel</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/grids.html" class="nav-list-link">oafp to build grids</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/manipulate-text.html" class="nav-list-link">oafp to manipulate text</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/parsing-unix-files.html" class="nav-list-link">oafp to parse Unix files</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/with-db.html" class="nav-list-link">oafp with DB</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/with-docker.html" class="nav-list-link">oafp with Docker commands</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/with-elasticsearch.html" class="nav-list-link">oafp with ElasticSearch</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/json-schemas.html" class="nav-list-link">oafp with JSON schemas</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/with-kubectl.html" class="nav-list-link">oafp with Kubectl</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/with-ollama.html" class="nav-list-link">oafp with Ollama</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/with-openaf.html" class="nav-list-link">oafp with OpenAF</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/with-oaf-ch.html" class="nav-list-link">oafp with OpenAF's channels</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/with-openai.html" class="nav-list-link">oafp with OpenAI</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/unix-commands.html" class="nav-list-link">oafp with Unix commands</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/with-windows.html" class="nav-list-link">oafp with Windows</a></li><li class="nav-list-item"><a href="/docs/guides/oafp/external-apis.html" class="nav-list-link">oafp with external APIs</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in oJob category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/guides/ojob/" class="nav-list-link">oJob</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/guides/ojob/llm-shortcut.html" class="nav-list-link">Example of using the LLM oJob shortcut</a></li><li class="nav-list-item"><a href="/docs/guides/ojob/oafp-shortcut.html" class="nav-list-link">Example of using the oafp oJob shortcut</a></li><li class="nav-list-item"><a href="/docs/guides/ojob/accessing-args-in-langs.html" class="nav-list-link">How to access args in multiple languages</a></li><li class="nav-list-item"><a href="/docs/guides/ojob/common-browse-ecr.html" class="nav-list-link">oJob AWS ECR browse functionality</a></li><li class="nav-list-item"><a href="/docs/guides/ojob/common-browse-s3.html" class="nav-list-link">oJob S3 browse functionality</a></li><li class="nav-list-item"><a href="/docs/guides/ojob/ojob-building-blocks.html" class="nav-list-link">oJob building blocks</a></li><li class="nav-list-item"><a href="/docs/guides/ojob/common-browse.html" class="nav-list-link">oJob common browse functionality</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in oJobIO category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/guides/ojobio/" class="nav-list-link">oJobIO</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/guides/ojobio/templates-apply.html" class="nav-list-link">Applying Templates</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/check-tls.html" class="nav-list-link">Check current Java TLS</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/compress-a-multi-line-string.html" class="nav-list-link">Compress a multi-line string</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/db-drivers.html" class="nav-list-link">DB JDBC drivers</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/decode-k8s-secret.html" class="nav-list-link">Decode a Kubernetes secret</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/elasticsearch-import-export.html" class="nav-list-link">ElasticSearch Import/Export</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/generating-ssh-jobs.html" class="nav-list-link">Generating SSH oJobs</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/get-ojob.html" class="nav-list-link">How to copy a remote oJob</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/kube-node-img-management.html" class="nav-list-link">Kubernetes nodes image management</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/quickly_download_java.html" class="nav-list-link">Quickly download portable JDKs/JREs</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/testing-adding-certs-java.html" class="nav-list-link">Testing & adding SSL/TLS certificates to a Java keystore</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/shell-autocomplete.html" class="nav-list-link">Unix shell auto-complete</a></li><li class="nav-list-item"><a href="/docs/guides/ojobio/validate-yaml.html" class="nav-list-link">Validate an YAML file</a></li></ul></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in How To category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/howto/" class="nav-list-link">How To</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/howto/color-formats.html" class="nav-list-link">How To - Change color formats</a></li><li class="nav-list-item"><a href="/docs/howto/Download-older-versions.html" class="nav-list-link">How To - Download older versions</a></li><li class="nav-list-item"><a href="/docs/howto/Update-JVM-version.html" class="nav-list-link">How To - Update the JVM version</a></li><li class="nav-list-item"><a href="/docs/howto/Use-ask.html" class="nav-list-link">How To - Use ask functions</a></li><li class="nav-list-item"><a href="/docs/howto/Use-files.html" class="nav-list-link">How To - Use files</a></li><li class="nav-list-item"><a href="/docs/howto/Use-log.html" class="nav-list-link">How To - Use log functions</a></li><li class="nav-list-item"><a href="/docs/howto/Download-without-curl-or-wget.html" class="nav-list-link">How to - Download without curl or wget</a></li><li class="nav-list-item"><a href="/docs/howto/Installation-global-ojobs.html" class="nav-list-link">Installation global oJobs</a></li><li class="nav-list-item"><a href="/installing-nightly.html" class="nav-list-link">Installing the nightly build</a></li><li class="nav-list-item"><a href="/installing.html" class="nav-list-link">Specific installation instructions</a></li></ul></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Reference category" aria-pressed="false">
        <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg>
      </button><a href="/docs/reference/" class="nav-list-link">Reference</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/reference/afbase.html" class="nav-list-link">afbase</a></li><li class="nav-list-item"><a href="/docs/reference/bsdiff.html" class="nav-list-link">bsdiff</a></li><li class="nav-list-item"><a href="/docs/reference/console.html" class="nav-list-link">console</a></li><li class="nav-list-item"><a href="/docs/reference/csv.html" class="nav-list-link">csv</a></li><li class="nav-list-item"><a href="/docs/reference/db.html" class="nav-list-link">db</a></li><li class="nav-list-item"><a href="/docs/reference/email.html" class="nav-list-link">email</a></li><li class="nav-list-item"><a href="/docs/reference/http.html" class="nav-list-link">http</a></li><li class="nav-list-item"><a href="/docs/reference/httpd.html" class="nav-list-link">httpd</a></li><li class="nav-list-item"><a href="/docs/reference/iocore.html" class="nav-list-link">iocore</a></li><li class="nav-list-item"><a href="/docs/reference/jmx.html" class="nav-list-link">jmx</a></li><li class="nav-list-item"><a href="/docs/reference/jmxserver.html" class="nav-list-link">jmxserver</a></li><li class="nav-list-item"><a href="/docs/reference/ojob.html" class="nav-list-link">oJob Reference Guide</a></li><li class="nav-list-item"><a href="/docs/reference/odoc.html" class="nav-list-link">odoc</a></li><li class="nav-list-item"><a href="/docs/reference/ow_ai.html" class="nav-list-link">ow.ai</a></li><li class="nav-list-item"><a href="/docs/reference/ow_ch.html" class="nav-list-link">ow.ch</a></li><li class="nav-list-item"><a href="/docs/reference/ow_debug.html" class="nav-list-link">ow.debug</a></li><li class="nav-list-item"><a href="/docs/reference/ow_format.html" class="nav-list-link">ow.format</a></li><li class="nav-list-item"><a href="/docs/reference/ow_java.html" class="nav-list-link">ow.java</a></li><li class="nav-list-item"><a href="/docs/reference/ow_metrics.html" class="nav-list-link">ow.metrics</a></li><li class="nav-list-item"><a href="/docs/reference/ow_net.html" class="nav-list-link">ow.net</a></li><li class="nav-list-item"><a href="/docs/reference/ow_oJob.html" class="nav-list-link">ow.oJob</a></li><li class="nav-list-item"><a href="/docs/reference/ow_obj.html" class="nav-list-link">ow.obj</a></li><li class="nav-list-item"><a href="/docs/reference/ow_python.html" class="nav-list-link">ow.python</a></li><li class="nav-list-item"><a href="/docs/reference/ow_sec.html" class="nav-list-link">ow.sec</a></li><li class="nav-list-item"><a href="/docs/reference/ow_server.html" class="nav-list-link">ow.server</a></li><li class="nav-list-item"><a href="/docs/reference/ow_template.html" class="nav-list-link">ow.template</a></li><li class="nav-list-item"><a href="/docs/reference/ow_test.html" class="nav-list-link">ow.test</a></li><li class="nav-list-item"><a href="/docs/reference/scope.html" class="nav-list-link">scope</a></li><li class="nav-list-item"><a href="/docs/reference/scopesigil.html" class="nav-list-link">scopesigil</a></li><li class="nav-list-item"><a href="/docs/reference/snmp.html" class="nav-list-link">snmp</a></li><li class="nav-list-item"><a href="/docs/reference/snmpd.html" class="nav-list-link">snmpd</a></li><li class="nav-list-item"><a href="/docs/reference/ssh.html" class="nav-list-link">ssh</a></li><li class="nav-list-item"><a href="/docs/reference/threads.html" class="nav-list-link">threads</a></li><li class="nav-list-item"><a href="/docs/reference/xml.html" class="nav-list-link">xml</a></li><li class="nav-list-item"><a href="/docs/reference/zip.html" class="nav-list-link">zip</a></li></ul></li></ul></li></ul>
  
</nav>




  
  
    <footer class="site-footer">
      This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll.
    </footer>
  
</div>

  
  <div class="main" id="top">
    <div id="main-header" class="main-header">
  
    

<div class="search" role="search">
  <div class="search-input-wrap">
    <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search OpenAF docs" aria-label="Search OpenAF docs" autocomplete="off">
    <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label>
  </div>
  <div id="search-results" class="search-results"></div>
</div>

  
  
  
</div>

    <div class="main-content-wrap">
      <nav aria-label="Breadcrumb" class="breadcrumb-nav">
  <ol class="breadcrumb-nav-list">
    <li class="breadcrumb-nav-list-item"><a href="/">OpenAF docs</a></li>
    <li class="breadcrumb-nav-list-item"><a href="/docs/guides/">Guides</a></li>
    <li class="breadcrumb-nav-list-item"><a href="/docs/guides/oafp/">oafp</a></li>
    <li class="breadcrumb-nav-list-item"><span>oafp basic examples</span></li>
  </ol>
</nav>


      <div id="main-content" class="main-content">
        <main>
          
            <h1 id="oafp-basic-examples">
  
  
    <a href="#oafp-basic-examples" class="anchor-heading" aria-labelledby="oafp-basic-examples"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> oafp basic examples
  
  
</h1>
    
<h2 id="simple-format-conversions">
  
  
    <a href="#simple-format-conversions" class="anchor-heading" aria-labelledby="simple-format-conversions"><svg viewBox="0 0 16 16" aria-hidden="true"><use xlink:href="#svg-link"></use></svg></a> Simple format conversions
  
  
</h2>
    

<div class="table-wrapper"><table>
  <thead>
    <tr>
      <th>Description</th>
      <th>Example</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td>Convert JSON to YAML</td>
      <td><code class="language-plaintext highlighter-rouge">oafp a-json-file.json out=yaml</code></td>
    </tr>
    <tr>
      <td>Convert YAML to JSON</td>
      <td><code class="language-plaintext highlighter-rouge">oafp a-yaml-file.yaml out=json</code></td>
    </tr>
    <tr>
      <td>Convert YAML to pretty JSON</td>
      <td><code class="language-plaintext highlighter-rouge">oafp a-yaml-file.yaml out=pjson</code></td>
    </tr>
    <tr>
      <td>Convert a NDJSON to a single JSON</td>
      <td><code class="language-plaintext highlighter-rouge">oafp a-ndjson.ndjson in=ndjson ndjsonjoin=true out=json</code></td>
    </tr>
    <tr>
      <td>Convert a JSON array to a multiple document YAML</td>
      <td><code class="language-plaintext highlighter-rouge">oafp a-json-array.json out=mdyaml</code></td>
    </tr>
  </tbody>
</table></div>

          

          
            
          
        </main>
        


      </div>
    </div>
    
      

<div class="search-overlay"></div>

    
  </div>

  
</body>
</html>

}\n---\n" pipe="(in: md, out: md)"

---

27

📖 AI | TogetherAI

List all available LLM models at together.ai with their corresponding type and price components order by the more expensive, for input and output

# export OAFP_MODEL="(type: openai, model: 'meta-llama/Meta-Llama-3-70B', url: 'https://api.together.xyz', key: '...', timeout: 9000000, temperature: 0)"
oafp in=llmmodels data="()" path="[].{id:id,name:display_name,type:type,ctxLen:context_length,priceHour:pricing.hourly,priceIn:pricing.input,priceOut:pricing.output,priceBase:pricing.base,priceFineTune:pricing.finetune}" sql="select * order by priceIn desc,priceOut desc" out=ctable

---

28

📖 APIs | NASA

Markdown table of near Earth objects by name, magnitude, if is potentially hazardous asteroids and corresponding distance

curl -s "https://api.nasa.gov/neo/rest/v1/feed?API_KEY=DEMO_KEY" | oafp path="near_earth_objects" maptoarray=true output=json | oafp path="[0][].{name:name,magnitude:absolute_magnitude_h,hazardous:is_potentially_hazardous_asteroid,distance:close_approach_data[0].miss_distance.kilometers}" sql="select * order by distance" output=mdtable

---

29

📖 APIs | Network

Converting the Cloudflare DNS trace info

curl -s https://1.1.1.1/cdn-cgi/trace | oafp in=ini out=ctree

---

30

📖 APIs | Network

Converting the Google DNS DoH query result

DOMAIN=yahoo.com && oafp path=Answer from="sort(data)" out=ctable url="https://8.8.8.8/resolve?name=$DOMAIN&type=a"

---

31

📖 APIs | Network

Generating a simple map of the current public IP address

curl -s https://ifconfig.co/json | oafp flatmap=true out=map

---

32

📖 APIs | Public Holidays

Return the public holidays for a given country on a given year

COUNTRY=US && YEAR=2024 && oafp url="https://date.nager.at/api/v2/publicholidays/$YEAR/$COUNTRY" path="[].{date:date,localName:localName,name:name}" out=ctable

---

33

📖 APIs | Space

How many people are in space and in which craft currently in space

curl -s http://api.open-notify.org/astros.json | oafp path="people" sql="select \"craft\", count(1) \"people\" group by \"craft\"" output=ctable

---

34

📖 APIs | iTunes

Search the Apple's iTunes database for a specific term

TRM="Mozart" && oafp url="https://itunes.apple.com/search?term=$TRM" out=ctree

---

35

📖 AWS | AMIs

List Amazon Linux 2023 available EC2 AMI images for a specific AWS region

REGION=eu-west-1 && oafp cmd="aws ec2 describe-images --owners amazon --filter \"Name=name,Values=al2023-*\" \"Name=state,Values=available\" --region $REGION" path="Images[].{name:Name,arch:Architecture,platform:PlatformDetails,description:Description,creationDate:CreationDate,deprecationTime:DeprecationTime}" sql="select * order by creationDate desc limit 25" out=ctable

---

36

📖 AWS | DynamoDB

Given an AWS DynamoDB table 'my-table' will produce a ndjson output with all table items.

# opack install AWS
oafp libs="@AWS/aws.js" in=ch inch="(type: dynamo, options: (region: us-west-1, tableName: my-table))" inchall=true data="__"  out=ndjson

---

37

📖 AWS | DynamoDB

Given an AWS DynamoDB table 'my-users' will produce a colored tree output by getting the item for the email key 'scott.tiger@example.com'

# opack install AWS
oafp in=ch inch="(type: dynamo, options: (region: eu-west-1, tableName: my-users))" data="(email: scott-tiger@example.com)" libs="@AWS/aws.js" out=ctree

---

38

📖 AWS | EC2

Given all AWS EC2 instances in an account produces a table with name, type, vpc and private ip sorted by vpc

aws ec2 describe-instances | oafp path="Reservations[].Instances[].{name:join('',Tags[?Key=='Name'].Value),type:InstanceType,vpc:VpcId,ip:PrivateIpAddress} | sort_by(@, &vpc)" output=ctable

---

39

📖 AWS | EKS

Builds an excel spreadsheet with all persistent volumes associated with an AWS EKS 'XYZ' with the corresponding Kubernetes namespace, pvc and pv names

# sudo yum install -y fontconfig
aws ec2 describe-volumes | oafp path="Volumes[?Tags[?Key=='kubernetes.io/cluster/XYZ']|[0].Value=='owned'].{VolumeId:VolumeId,Name:Tags[?Key=='Name']|[0].Value,KubeNS:Tags[?Key=='kubernetes.io/created-for/pvc/namespace']|[0].Value,KubePVC:Tags[?Key=='kubernetes.io/created-for/pvc/name']|[0].Value,KubePV:Tags[?Key=='kubernetes.io/created-for/pv/name']|[0].Value,AZ:AvailabilityZone,Size:Size,Type:VolumeType,CreateTime:CreateTime,State:State,AttachTime:join(',',nvl(Attachments[].AttachTime,from_slon('[]'))[]),InstanceId:join(',',nvl(Attachments[].InstanceId,from_slon('[]'))[])}" from="sort(KubeNS,KubePVC)" out=xls xlsfile=xyz_pvs.xlsx

---

40

📖 AWS | EKS

Produce a list of all AWS EKS Kubernetes service accounts, per namespace, which have an AWS IAM role associated with it.

oafp cmd="kubectl get sa -A -o json" path="items[].{ serviceAccount: metadata.name, ns: metadata.namespace, iamRole: nvl(metadata.annotations.\"eks.amazonaws.com/role-arn\", 'n/a') }" sql="select * where iamRole <> 'n/a'" out=ctable

---

41

📖 AWS | Inspector

Given an AWS ECR repository and image tag retrieve the AWS Inspector vulnerabilities and list a quick overview in an Excel spreadsheet

REPO=my/image && TAG=1.2.3 && aws inspector2 list-findings --filter "{\"ecrImageRepositoryName\":[{\"comparison\":\"EQUALS\",\"value\":\"$REPO\"}],\"ecrImageTags\":[{\"comparison\":\"EQUALS\",\"value\":\"$TAG\"}]}" --output json | oafp path="findings[].{title:title,severity:severity,lastObservedAt:lastObservedAt,firstObservedAt:firstObservedAt,lastObservedAt:lastObservedAt,fixAvailable:fixAvailable,where:join(', ',(packageVulnerabilityDetails.vulnerablePackages[].nvl(filePath, name)))}" out=xls

---

42

📖 AWS | Lambda

Prepares a table of AWS Lambda functions with their corresponding main details

aws lambda list-functions | oafp path="Functions[].{Name:FunctionName,Runtime:Runtime,Arch:join(',',Architectures),Role:Role,MemorySize:MemorySize,EphStore:EphemeralStorage.Size,CodeSize:CodeSize,LastModified:LastModified}" from="sort(Name)" out=ctable

---

43

📖 AWS | Lambda

Prepares a table, for a specific AWS Lambda function during a specific time periods, with number of invocations and minimum, average and maximum duration per periods from AWS CloudWatch

export _SH="aws cloudwatch get-metric-statistics --namespace AWS/Lambda --start-time 2024-03-01T00:00:00Z --end-time 2024-04-01T00:00:00Z --period 3600 --dimensions Name=FunctionName,Value=my-function"
$_SH --statistics Sum --metric-name Invocations  | oafp path="Datapoints[].{ts:Timestamp,cnt:Sum}" out=ndjson > data.ndjson
$_SH --statistics Average --metric-name Duration | oafp path="Datapoints[].{ts:Timestamp,avg:Average}" out=ndjson >> data.ndjson
$_SH --statistics Minimum --metric-name Duration | oafp path="Datapoints[].{ts:Timestamp,min:Minimum}" out=ndjson >> data.ndjson
$_SH --statistics Maximum --metric-name Duration | oafp path="Datapoints[].{ts:Timestamp,max:Maximum}" out=ndjson >> data.ndjson
oafp data.ndjson ndjsonjoin=true opath="[].{ts:ts,cnt:nvl(cnt,\`0\`),min:nvl(min,\`0\`),avg:nvl(avg,\`0\`),max:nvl(max,\`0\`)}" out=json | oafp isql="select \"ts\",max(\"cnt\") \"cnt\",max(\"min\") \"min\",max(\"avg\") \"avg\",max(\"max\") \"max\" group by \"ts\" order by \"ts\"" opath="[].{ts:ts,cnt:cnt,min:from_ms(min,'(abrev:true,pad:true)'),avg:from_ms(avg,'(abrev:true,pad:true)'),max:from_ms(max,'(abrev:true,pad:true)')}" out=ctable

---

44

📖 AWS | RDS Data

Given an AWS RDS, postgresql based, database with RDS Data API activated execute the 'analyze' statement for each table on the 'public' schema.

SECRET="arn:aws:secretsmanager:eu-west-1:123456789000:secret:dbname-abc123" \
DB="arn:aws:rds:eu-west-1:123456789000:cluster:dbname" \
REGION="eu-west-1" \
oafp libs=AWS in=awsrdsdata awssecret=$SECRET awsdb=$DB awsregion=$REGION \
data="select table_schema, table_name, table_type from information_schema.tables where table_schema='public' and table_type='BASE TABLE'" \
path="formattedRecords[].{libs:'AWS',in:'awsrdsdata',awssecret:'$SECRET',awsdb:'$DB',awsregion:'$REGION',data:concat(concat('analyze \"', table_name),'\"')}" \
out=json | oafp in=oafp

---

45

📖 AWS | VPC

On an AWS account go through all AWS regions and produce an output table with each VPC CIDR

cat <<EOF | oafp -f -
cmd         : aws ec2 describe-regions --output json
out         : template
template    : |
  [(cmd: aws ec2 describe-vpcs --region  --output json, path: 'Vpcs[].{RegionName: \'\', VpcId:VpcId, CidrBlock:CidrBlock}') | ]
templatetmpl: true
pipe        :
  in      : oafp
  path    : "[][]" 
  out     : ctable
  sql     : select * order by CidrBlock
EOF

---

46

📖 Azure | Bing

Given an Azure Bing Search API key and a query returns the corresponding search result from Bing.

QUERY="OpenAF" && KEY="12345" && curl -X GET "https://api.bing.microsoft.com/v7.0/search?q=$QUERY" -H "Ocp-Apim-Subscription-Key: $KEY" | oafp out=ctree

---

47

📖 Channels | S3

Given a S3 bucket will load data from a previously store data in a provided prefix

# opack install s3
oafp libs="@S3/s3.js" in=ch inch="(type: s3, options: (s3url: 'https://play.min.io:9000', s3accessKey: abc123, s3secretKey: 'xyz123', s3bucket: test, s3prefix: data, multifile: true, gzip: true))" data="()" inchall=true out=ctable

---

48

📖 Channels | S3

Given a S3 bucket will save a list of data (the current list of name and versions of OpenAF's oPacks) within a provided prefix

# opack install s3
oafp libs="@S3/s3.js" -v path="openaf.opacks" out=ch ch="(type: s3, options: (s3url: 'https://play.min.io:9000', s3accessKey: abc123, s3secretKey: 'xyz123', s3bucket: test, s3prefix: data, multifile: true, gzip: true))" chkey=name

---

49

📖 Chart | Unix

Output a chart with the current Unix load using uptime

oafp cmd="uptime" in=raw path="replace(trim(@), '.+ ([\d\.]+),? ([\d\.]+),? ([\d\.]+)\$', '', '\$1|\$2|\$3').split(@,'|')" out=chart chart="dec2 [0]:green:load -min:0" loop=1 loopcls=true

---

50

📖 DB | H2

Perform a SQL query over a H2 database.

echo "select * from \"data\"" | oafp in=db indbjdbc="jdbc:h2:./data" indbuser=sa indbpass=sa out=ctable

---

51

📖 DB | H2

Perform queries and DML SQL statements over a H2 databases

# Dump data into a table
oafp data="[(id: 1, val: x)|(id: 2, val: y)|(id: 3, val: z)]" in=slon out=db dbjdbc="jdbc:h2:./data" dbuser=sa dbpass=sa dbtable=data
# Copy data to another new table
ESQL='create table newdata as select * from "data"' && oafp in=db indbjdbc="jdbc:h2:./data" indbuser=sa indbpass=sa indbexec=true data="$ESQL"
# Drop the original table
ESQL='drop table "data"' && oafp in=db indbjdbc="jdbc:h2:./data" indbuser=sa indbpass=sa indbexec=true data="$ESQL"
# Output data from the new table
SQL='select * from newdata' && oafp in=db indbjdbc="jdbc:h2:./data" indbuser=sa indbpass=sa data="$SQL" out=ctable

---

52

📖 DB | H2

Store the json result of a command into a H2 database table.

oaf -c "\$o(listFilesRecursive('.'),{__format:'json'})" | oafp out=db dbjdbc="jdbc:h2:./data" dbuser=sa dbpass=sa dbtable=data

---

53

📖 DB | List

List all OpenAF's oPack pre-prepared JDBC drivers

oafp in=oaf data="data=getOPackRemoteDB()" maptoarray=true opath="[].{name:name,description:description,version:version}" from="sort(name)" out=ctable

---

54

📖 DB | Mongo

List all records from a specific MongoDB database and collection from a remote Mongo database.

# opack install mongo
oafp libs="@Mongo/mongo.js" in=ch inch="(type: mongo, options: (database: default, collection: collection, url: 'mongodb://a.server:27017'))" inchall=true path="[].delete(@,'_id')" data="()"

---

55

📖 DB | PostgreSQL

Given a JDBC postgresql connection retrieve schema information (DDL) of all tables.

oafp in=db indbjdbc=jdbc:postgresql://hh-pgsql-public.ebi.ac.uk:5432/pfmegrnargs indbuser=reader indbpass=NWDMCE5xdipIjRrp data="select table_catalog, table_schema, table_name, table_type from information_schema.tables order by table_catalog, table_schema, table_name, table_type" out=ctable

---

56

📖 DB | SQLite

Lists all files in openaf.jar, stores the result in a 'data' table on a SQLite data.db file and performs a query over the stored data.

# ojob ojob.io/db/getDriver op=install db=sqlite
opack install jdbc-sqlite
# Dump data into a 'data' table
oafp in=ls data=openaf.jar out=db dbjdbc="jdbc:sqlite:data.db" dblib=sqlite dbtable="data"
# Gets stats over the dump data from the 'data' table
SQL='select count(1) numberOfFiles, round(avg("size")) avgSize, sum("size") totalSize from "data"' && oafp in=db indbjdbc="jdbc:sqlite:data.db" indblib=sqlite data="$SQL" out=ctable

---

57

📖 DB | SQLite

Perform a query over a database using JDBC.

# ojob ojob.io/db/getDriver op=install db=sqlite
opack install jdbc-sqlite
echo "select * from data" | oafp in=db indbjdbc="jdbc:sqlite:data.db" indbtable=data indblib=sqlite out=ctable

---

58

📖 DB | SQLite

Store the json result on a SQLite database table.

# ojob ojob.io/db/getDriver op=install db=sqlite
opack install jdbc-sqlite
oaf -c "\$o(listFilesRecursive('.'),{__format:'json'})" | oafp out=db dbjdbc="jdbc:sqlite:data.db" dbtable=data dblib=sqlite

---

59

📖 Diff | Envs

Given two JSON files with environment variables performs a diff and returns a colored result with the corresponding differences

env | oafp in=ini out=json > data1.json
# change one or more environment variables
env | oafp in=ini out=json > data2.json
oafp in=oafp data="[(file: data1.json)|(file: data2.json)]" diff="(a:'[0]',b:'[1]')" color=true

---

60

📖 Diff | Lines

Performing a diff between two long command lines to spot differences

oafp diff="(a:before,b:after)" diffchars=true in=yaml color=true
# as stdin enter
before: URL="http://localhost:9090" && METRIC="go_memstats_alloc_bytes" && TYPE="bytes" && LABELS="job=\"prometheus\"" && START="2024-06-18T20:00:00Z" && END="2024-06-18T20:15:00Z" && STEP=5 && echo "{query:'max($METRIC{$LABELS})',start:'$START',end:'$END',step:$STEP}" | oafp in=ch inch="(type:prometheus,options:(urlQuery:'$URL'))" inchall=true out=json | oafp path="[].set(@, 'main').map(&{metric:'$METRIC',job:get('main').metric.job,timestamp:to_date(mul([0],\`1000\`)),value:to_number([1])}, values) | []" out=schart schart="$TYPE '[].value':green:$METRIC -min:0"

after: URL="http://localhost:9090" && METRIC="go_memstats_alloc_bytes" && TYPE="bytes" && LABELS="job=\"prometheus\"" && START="2024-06-18T20:00:00Z" && END="2024-06-18T20:15:00Z" && STEP=5 && echo "{query:'max($METRIC{$LABELS})',start:'$START',end:'$END',step:$STEP}" | oafp in=ch inch="(type:prometheus,options:(urlQuery:'$URL'))" inchall=true out=json | oafp path="[].set(@, 'main').map(&{metric:'$METRIC',job:get('main').metric.job,timestamp:to_date([0]),value:to_number([1])}, values) | []" out=schart schart="$TYPE '[].value':green:$METRIC -min:0"
#
# Ctrl^D 
# as the result the difference between before and after will appear as red characters

---

61

📖 Diff | Path

Given two JSON files with the parsed PATH environment variable performs a diff and returns a colored result with the corresponding differences

env | oafp in=ini path="PATH.split(@,':')" out=json > data1.json
# export PATH=$PATH:/some/new/path
env | oafp in=ini path="PATH.split(@,':')" out=json > data2.json
oafp in=oafp data="[(file: data1.json)|(file: data2.json)]" diff="(a:'sort([0])',b:'sort([1])')" color=true

---

62

📖 Docker | Containers

Output a table with the list of running containers.

oafp cmd="docker ps --format json" input=ndjson ndjsonjoin=true path="[].{id:ID,name:Names,state:State,image:Image,networks:Networks,ports:Ports,Status:Status}" sql="select * order by networks,state,name" output=ctable

---

63

📖 Docker | Listing

List all containers with the docker-compose project, service name, file, id, name, image, creation time, status, networks and ports.

docker ps -a --format=json | oafp in=ndjson ndjsonjoin=true out=ctree path="[].insert(@,'Labels',sort_by(split(Labels,',')[].split(@,'=').{key:[0],value:[1]},&key))" out=json | oafp path="[].{dcProject:nvl(Labels[?key=='com.docker.compose.project']|[0].value,''),dcService:nvl(Labels[?key=='com.docker.compose.service']|[0].value,''),ID:ID,Names:Names,Image:Image,Created:RunningFor,Status:Status,Ports:Ports,Networks:Networks,dcFile:nvl(Labels[?key=='com.docker.compose.project.config_files']|[0].value,'')}" sql="select * order by dcProject,dcService,Networks,Names" out=ctable

---

64

📖 Docker | Listing

List all containers with their corresponding labels parsed and sorted.

docker ps -a --format=json | oafp in=ndjson ndjsonjoin=true out=ctree path="[].insert(@,'Labels',sort_by(split(Labels,',')[].split(@,'=').{key:[0],value:[1]},&key))" out=ctree

---

65

📖 Docker | Network

Output a table with the docker networks info.

docker network ls --format json | oafp in=ndjson ndjsonjoin=true out=ctable

---

66

📖 Docker | Registry

List all a table of docker container images repository and corresponding tags of a private registry.

# opack install DockerRegistry
# check more options with 'oafp libs=dockerregistry help=dockerregistry' 
oafp libs=dockerregistry in=registryrepos data="()" inregistryurl=http://localhost:5000 inregistrytags=true out=ctable

---

67

📖 Docker | Registry

List all the docker container image repositories of a private registry.

# opack install DockerRegistry
# check more options with 'oafp libs=dockerregistry help=dockerregistry' 
oafp libs=dockerregistry data="()" in=registryrepos inregistryurl=http://localhost:5000

---

68

📖 Docker | Registry

List all the docker container image repository tags of a private registry.

# opack install DockerRegistry
# check more options with 'oafp libs=dockerregistry help=dockerregistry' 
oafp libs=dockerregistry data="library/nginx" in=registrytags inregistryurl=http://localhost:5000

---

69

📖 Docker | Stats

Output a table with the docker stats broken down for each value.

oafp cmd="docker stats --no-stream" in=lines linesvisual=true linesjoin=true out=ctree path="[].{containerId:\"CONTAINER ID\",pids:PIDS,name:\"NAME\",cpuPerc:\"CPU %\",memory:\"MEM USAGE / LIMIT\",memPerc:\"MEM %\",netIO:\"NET I/O\",blockIO:\"BLOCK I/O\"}|[].{containerId:containerId,pids:pids,name:name,cpuPerc:replace(cpuPerc,'%','',''),memUsage:from_bytesAbbr(split(memory,' / ')[0]),memLimit:from_bytesAbbr(split(memory,' / ')[1]),memPerc:replace(memPerc,'%','',''),netIn:from_bytesAbbr(split(netIO,' / ')[0]),netOut:from_bytesAbbr(split(netIO,' / ')[1]),blockIn:from_bytesAbbr(split(blockIO,' / ')[0]),blockOut:from_bytesAbbr(split(blockIO,' / ')[1])}" out=ctable

---

70

📖 Docker | Storage

Output a table with the docker volumes info.

docker volume ls --format json | oafp in=ndjson ndjsonjoin=true out=ctable

---

71

📖 Docker | Volumes

Given a list of docker volumes will remove all of them, if not in use, in parallel for faster execution.

docker volume ls --format json | oafp in=ndjson ndjsonjoin=true path="[].Name" out=cmd outcmd="docker volume rm {}" outcmdparam=true

---

72

📖 ElasticSearch | Cluster

Get an ElasticSearch/OpenSearch cluster nodes overview

export ES_URL=http://elastic.search:9200
export ES_EXTRA="--insecure"
curl -s "$ES_URL/_cat/nodes?format=json" $ES_EXTRA | oafp sql="select * order by ip" out=ctable

---

73

📖 ElasticSearch | Cluster

Get an ElasticSearch/OpenSearch cluster per host data allocation

export ES_URL=http://elastic.search:9200
export ES_EXTRA="--insecure"
curl -s "$ES_URL/_cat/allocation?format=json&bytes=b" $ES_EXTRA | oafp sql="select * order by host" out=ctable

---

74

📖 ElasticSearch | Cluster

Get an ElasticSearch/OpenSearch cluster settings flat

export ES_URL=http://elastic.search:9200
export ES_EXTRA="--insecure"
curl -s "$ES_URL/_cluster/settings?include_defaults=true&flat_settings=true" $ES_EXTRA | oafp out=ctree

---

75

📖 ElasticSearch | Cluster

Get an ElasticSearch/OpenSearch cluster settings non-flatted

export ES_URL=http://elastic.search:9200
export ES_EXTRA="--insecure"
curl -s "$ES_URL/_cluster/settings?include_defaults=true" $ES_EXTRA | oafp out=ctree

---

76

📖 ElasticSearch | Cluster

Get an ElasticSearch/OpenSearch cluster stats per node

export ES_URL=http://elastic.search:9200
export ES_EXTRA="--insecure"
curl -s "$ES_URL/_nodes/stats/indices/search" $ES_EXTRA | oafp out=ctree

---

77

📖 ElasticSearch | Cluster

Get an overview of an ElasticSearch/OpenSearch cluster health

export ES_URL=http://elastic.search:9200
export ES_EXTRA="--insecure"
curl -s "$ES_URL/_cat/health?format=json" $ES_EXTRA | oafp out=ctable

---

78

📖 ElasticSearch | Indices

Get an ElasticSearch/OpenSearch count per index

export ES_URL=http://elastic.search:9200
export ES_EXTRA="--insecure"
curl -s "$ES_URL/kibana_sample_data_flights/_count" $ES_EXTRA | oafp

---

79

📖 ElasticSearch | Indices

Get an ElasticSearch/OpenSearch indices overview

export ES_URL=http://elastic.search:9200
export ES_EXTRA="--insecure"
curl -s "$ES_URL/_cat/indices?format=json&bytes=b" $ES_EXTRA | oafp sql="select * order by index" out=ctable

---

80

📖 ElasticSearch | Indices

Get an ElasticSearch/OpenSearch settings for a specific index

export ES_URL=http://elastic.search:9200
export ES_EXTRA="--insecure"
curl -s "$ES_URL/kibana_sample_data_flights/_settings" $ES_EXTRA | oafp out=ctree

---

81

📖 GIT | History

Give a GIT repository will retrieve the current log history and parse it to an Excel (XLS) file.

opack install plugin-XLS
git log --pretty=format:'{c:"%H",a:"%an",d:"%ad",m:"%s"}' | oafp in=ndjson ndjsonjoin=true path="[].{commit:c,author:a,date:to_date(d),message:m}" out=xls outfile=data.xlsx xlsopen=false

---

82

📖 GPU | Nvidia

Builds a grid with two charts providing a visualization over a Nvidia GPU usage and the corresponding memory usage for a specific GPU_IDX (gpu index)

GPU_IDX=0 &&oafp cmd="nvidia-smi --query-gpu=index,name,memory.total,memory.used,memory.free,utilization.gpu --format=csv,nounits | oafp in=lines path=\"map(&trim(@),split(@,',')).join(',',@)\"" in=csv path="[$GPU_IDX].{memTotal:mul(to_number(\"memory.total [MiB]\"),\`1024\`),memUsed:mul(to_number(\"memory.used [MiB]\"),\`1024\`),memFree:mul(to_number(\"memory.free [MiB]\"),\`1024\`),gpuUse:to_number(\"utilization.gpu [%]\")}" out=grid grid="[[(title: usage, type: chart, obj: 'int gpuUse:green:usage -min:0 -max:100')]|[(title: memory, type: chart, obj: 'bytes memTotal:red:total memUsed:cyan:used -min:0')]]" loopcls=true loop=1

---

83

📖 GPU | Nvidia

Get current Nvidia per-gpu usage

nvidia-smi --query-gpu=index,name,memory.total,memory.used,memory.free,utilization.gpu --format=csv,nounits | oafp in=lines path="map(&trim(@),split(@,',')).join(',',@)" | oafp in=csv out=ctable

---

84

📖 Generic | Arrays

Converting an array of strings into an array of maps

oafp -v path="java.params[].insert(from_json('{}'), 'param', @).insert(@, 'len', length(param))"

---

85

📖 Generic | Avro

Given an Avro data file outputs it's corresponding statistics

# opack install avro
oafp libs=avro data.avro inavrostats=true

---

86

📖 Generic | Avro

Given an Avro data file outputs the correspoding schema

# opack install avro
oafp libs=avro data.avro inavroschema=true

---

87

📖 Generic | Avro

Reads an Avro data file as input

# opack install avro
oafp data.avro libs=avro out=ctable

---

88

📖 Generic | Avro

Write an Avro data file as an output

# opack install avro
oafp data.json libs=avro out=avro avrofile=data.avro

---

89

📖 Generic | BOM

Given a container image use syft to generate a table with a corresponding bill-of-materials (BOM) table with each identified artifact name, version, type, language, found path and maven group & id (if applicable).

IMAGE=openaf/oaf:t8 && oafp cmd="syft scan registry:$IMAGE -o syft-json" path="artifacts[].{name:name,version:version,type:type,language:language,paths:join(',',locations[].path),groupId:nvl(metadata.pomProperties.groupId,'n/a'),artifactId:nvl(metadata.pomProperties.artifactId,'n/a')}" sql="select * order by type, name, version" out=ctable

---

90

📖 Generic | Base64

Encode/decode data (or text-like files) to/from gzip base64 representation for easier packing and transport.

# encode a data file to a gzip base64 representation
oafp data.json out=gb64json > data.gb64
# decode a gzip base64 representation back into a data file
oafp data.gb64 in=gb64json out=json > data.json

---

91

📖 Generic | CSV

Given a BOM CSV with multiple fields (7 in total) return a new CSV with just 3 of the original fields.

# Check current fields (filter for first 5 records)
oafp bom.csv sql="select * limit 5" out=ctable
# Test with just 3 fields (filter for first 5 records)
oafp bom.csv sql="select name, version, group limit 5" out=ctable
# Finally produce the new CSV with just 3 fields
oafp bom.csv sql="select name, version, group" out=csv > new_bom.csv

---

92

📖 Generic | Commands

Given an input array with phone numbers will run parallel output commands, calling ojob.io/telco/phoneNumber, for each entry effectively building an output from those multiple command executions.

oafp data="[(p:911234567)|(p:+18004564567)]" in=slon out=cmd outcmdtmpl=true outcmd="ojob ojob.io/telco/phoneNumber country=PT number= -json" | oafp in=ndjson ndjsonjoin=true path="[].phoneInfo" out=ctree

---

93

📖 Generic | End of life

List the versions of a given product with the corresponding end-of-life dates (using endofline.date API)

PRODUCT=jetty && oafp url="https://endoflife.date/api/$PRODUCT.json" out=ctable sql="select * order by releaseDate"

---

94

📖 Generic | Excel

Building an Excel file with the AWS IPv4 and IPv6 ranges (1).

curl https://ip-ranges.amazonaws.com/ip-ranges.json > ip-ranges.json

---

95

📖 Generic | Excel

Building an Excel file with the AWS IPv4 and IPv6 ranges (2).

oafp ip-ranges.json path=prefixes out=xls xlsfile=aws-ip-ranges.xlsx xlssheet=ipv4

---

96

📖 Generic | Excel

Building an Excel file with the AWS IPv4 and IPv6 ranges (3).

oafp ip-ranges.json path=ipv6_prefixes out=xls xlsfile=aws-ip-ranges.xlsx xlssheet=ipv6

---

97

📖 Generic | Excel

Processes each json file in /some/data creating and updating the data.xlsx file with a sheet for each file.

find /some/data -name "*.json" | xargs -I '{}' /bin/sh -c 'oafp file={} output=xls xlsfile=data.xlsx xlsopen=false xlssheet=$(echo {} | sed "s/.*\/\(.*\)\.json/\1/g" )'

---

98

📖 Generic | Excel

Store and retrieve data from an Excel spreadsheet

# Storing data
oafp cmd="oaf -c \"sprint(listFilesRecursive('/usr/bin'))\"" out=xls xlsfile=data.xlsx
# Retrieve data
oafp in=xls file=data.xlsx xlscol=A xlsrow=1 out=pjson

---

99

📖 Generic | File listing

How to get the total abbreviated size of specific files using a SQL query

DPATH=. && oafp in=ls data=$DPATH sql="select sum(\"size\") total where \"filename\" like 'test%'" opath="[0].to_bytesAbbr(TOTAL)"

---

100

📖 Generic | HTML

Generate a HTML with table of emoticons/emojis by category, group, name, unicode and html code.

oafp url="https://emojihub.yurace.pro/api/all" path="[].{category:category,group:group,name:name,len:length(unicode),unicode:join('<br>',unicode),htmlCode:replace(join('<br>', htmlCode),'&','g','&amp;'),emoji:join('', htmlCode)}" out=mdtable | oafp in=md out=html

---

101

📖 Generic | HTML

Given an input file, in a specific language (e.g. yaml, json, bash, etc…), output an HTML representation with syntax highlighting.

OUT=yaml && FILE=data.yaml && oafp file=$FILE in=raw outkey=data out=json | oafp out=template templatetmpl=true template="\`\`\`$OUT\n}\n\`\`\`" | oafp in=md out=html

---

102

📖 Generic | Hex

Outputs an hexadecimal representation of the characters of the file provided allowing to adjust how many per line/row.

oafp some.file in=rawhex inrawhexline=15 out=ctable

---

103

📖 Generic | JWT

Generates an output JWT (JSON Web Token) given the provided input claims signed with a provided secret.

oafp data="(claims: (c1: a1, c2: a2))" out=jwt jwtsecret=this_is_my_own_very_long_signature
# you can check it adding "| oafp in=jwt"
# you can also verify the signature adding instead "| oafp in=jwt injwtsecret=this_is_my_own_very_long_signature injwtverify=true" which will add a __verified boolean field.

---

104

📖 Generic | JWT

Given an input JWT (JSON Web Token) converts it to a human readable format.

echo "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" | oafp in=jwt

---

105

📖 Generic | List files

After listing all files and folders recursively producing a count table by file extension.

FPATH="git/ojob.io" && oafp in=ls lsrecursive=true data="$FPATH" path="[].insert(@,'extension',if(isFile && index_of(filename,'.')>'0',replace(filename,'^.+\.([^\.]+)$','','\$1'),'<dir>'))" from="countBy(extension)" out=json | oafp from="sort(-_count)" out=ctable

---

106

📖 Generic | RSS

Builds an HTML file with the current linked news titles, publication date and source from Google News RSS.

RSS="https://news.google.com/rss" && oafp url="$RSS" path="rss.channel.item[].{title:replace(t(@,'[]()'),'\|','g','\\|'),date:pubDate,source:source._}" from="sort(-date)" out=mdtable | oafp in=md out=html

---

107

📖 Generic | RSS

Example of generating a HTML list of titles, links and publication dates from a RSS feed

oafp url="https://blog.google/rss" path="rss.channel.item" sql="select title, link, pubDate" output=html

---

108

📖 Generic | RSS

Generates a HTML page with the current news from Google News, order by date, and opens a browser with it.

oafp url="https://news.google.com/rss" path="rss.channel.item[].{title:title,link:link,date:pubDate,source:source._}" out=template templatetmpl=true template="<html><body><h1>Current Main News</h1><ul><li><a href='' target='_blank'></a> <br><small> | Source: </small></li></ul></body></html>" sql="select * order by date desc" | oafp in=raw out=html

---

109

📖 Generic | RSS

Parses the Slashdot's RSS feed news into a quick clickable HTML page in a browser

RSS="http://rss.slashdot.org/Slashdot/slashdot" && oafp url="$RSS" path="RDF.item[].{title:replace(t(@,'[]()'),'\|','g','\\|'),department:department,date:date}" from="sort(-date)" out=mdtable | oafp in=md out=html

---

110

📖 Generic | Reverse

Given a text file revert the line ordering

cat somefile.txt | oafp in=lines linesjoin=true path="reverse([]).join('\n',@)"

---

111

📖 Generic | Set

Given two json files, with arrays of component versions, generate a table with the difference on one of the sides.

oafp data="[(file: versions-latest.json)|(file: versions-build.json)]" in=oafp set="(a:'[0]',b:'[1]')" setop=diffb out=ctable

---

112

📖 Generic | Set

Given two json files, with arrays of component versions, generate a table with the union of the two sides.

oafp data="[(file: versions-latest.json)|(file: versions-build.json)]" in=oafp set="(a:'[0]',b:'[1]')" setop=union out=ctable

---

113

📖 Generic | Template

Given a meal name will search 'The Meal DB' site for the corresponding recipe and render a markdown HTML of the corresponding recipe.

MEAL="Pizza" && echo "# \n>  | \n<a href=\"\"><img align=\"center\" width=1280 src=\"\"></a>\n\n## Ingredients\n\n| Ingredient | Measure |\n|---|---|\n|||\n\n\n## Instructions\n\n\n\n}" > _template.hbs && oafp url="https://www.themealdb.com/api/json/v1/1/search.php?s=$MEAL" path="set(meals[0],'o').set(k2a(get('o'),'strIngredient','i',\`true\`),'is').set(k2a(get('o'),'strMeasure','m',\`true\`),'ms')|get('o').insert(get('o'),'ingredients',ranges(length(get('is')),\`0\`,\`1\`).map(&{ ingredient: geta('is',@).i, measure: geta('ms',@).m }, @))" out=json | oafp out=template template=_template.hbs | oafp in=md out=html htmlcompact=true

---

114

📖 Generic | Text

Get a json with lyrics of a song.

curl -s https://api.lyrics.ovh/v1/Coldplay/Viva%20La%20Vida | oafp path="substring(lyrics,index_of(lyrics, '\n'),length(lyrics))"

---

115

📖 Generic | Text

Search a word in the English dictionary returning phonetic, meanings, synonyms, antonyms, etc.

WORD="google" && oafp url="https://api.dictionaryapi.dev/api/v2/entries/en/$WORD"

---

116

📖 Generic | URL

Given an URL to a resource on a website determine how long ago is was modified given the data provided by the server.

URL="https://openaf.io/openaf.jar" && oafp url="$URL" urlmethod=head path="response.timeago(to_ms(\"last-modified\"))"

---

117

📖 Generic | YAML

Given an YAML file with a data array composed of maps with fields 'c', 's', 'd' and 'e' filter by any record where any field doesn't have contents.

oafp oafp-examples.yaml path="data[?length(nvl(c, \'\')) == \`0\` || length(nvl(s, \'\')) == \`0\` || length(nvl(d, \'\')) == \`0\` || length(nvl(e, \'\')) == \`0\`]"

---

118

📖 GitHub | GIST

Using GitHub's GIST functionality retrieves and parses an oAFp examples YAML file with the template and the corresponding data.

opack install GIST
oafp libs="@GIST/gist.js" in=ch inch="(type: gist)" data="(id: '557e12e4a840d513635b3a57cb57b722', file: oafp-examples.yaml)" path=content | oafp in=yaml out=template templatedata=data templatepath=tmpl

---

119

📖 GitHub | Releases

Builds a table of GitHub project releases

curl -s https://api.github.com/repos/openaf/openaf/releases | oafp sql="select name, tag_name, published_at order by published_at" output=ctable

---

120

📖 GitHub | Releases

Parses the latest GitHub project release markdown notes

curl -s https://api.github.com/repos/openaf/openaf/releases | oafp path="[0].body" output=md

---

121

📖 Grid | Java

Parses a Java hsperf data + the current rss java process memory into a looping grid.

JPID=12345 && HSPERF=/tmp/hsperfdata_openvscode-server/$JPID && oafp in=oafp data="[(file: $HSPERF, in: hsperf, path: java)|(cmd: 'ps -p $JPID -o rss=', path: '{ rss: mul(@,\`1024\`) }')]" merge=true out=grid grid="[[(title:Threads,type:chart,obj:'int threads.live:green:live threads.livePeak:red:peak threads.daemon:blue:daemon -min:0')|(title:RSS,type:chart,obj:'bytes rss:blue:rss')]|[(title:Heap,type:chart,obj:'bytes __mem.total:red:total __mem.used:blue:used -min:0')|(title:Metaspace,type:chart,obj:'bytes __mem.metaTotal:blue:total __mem.metaUsed:green:used -min:0')]]" loop=1

---

122

📖 Grid | Java

Parses a Java hsperf data into a looping grid.

HSPERF=/tmp/hsperfdata_user/12345 && oafp $HSPERF in=hsperf path=java out=grid grid="[[(title:Threads,type:chart,obj:'int threads.live:green:live threads.livePeak:red:peak threads.daemon:blue:daemon -min:0')|(title:Class Loaders,type:chart,obj:'int cls.loadedClasses:blue:loaded cls.unloadedClasses:red:unloaded')]|[(title:Heap,type:chart,obj:'bytes __mem.total:red:total __mem.used:blue:used -min:0')|(title:Metaspace,type:chart,obj:'bytes __mem.metaTotal:blue:total __mem.metaUsed:green:used -min:0')]]" loop=1

---

123

📖 Grid | Kubernetes

Displays a continuous updating grid with a line chart with the number of CPU throtlles and bursts recorded in the Linux cgroup cpu stats of a container running in Kubernetes and the source cpu.stats data

oafp cmd="cat /sys/fs/cgroup/cpu.stat | sed 's/ /: /g'" in=yaml out=grid grid="[[(title:cpu.stat,type:tree)|(title:chart,type:chart,obj:'int nr_throttled:red:throttled nr_bursts:blue:bursts -min:0 -vsize:10')]]" loop=1

---

124

📖 Grid | Mac

Shows a grid with the Mac network metrics and 4 charts for in, out packets and in, out bytes

# opack install mac
sudo powermetrics --help > /dev/null
oafp libs=Mac cmd="sudo powermetrics --format=plist --show-initial-usage -n 0 --samplers network" in=plist path=network out=grid grid="[[(title:data,path:@,xsnap:2)]|[(title:in packets,type:chart,obj:'int ipackets:blue:in')|(title:out packets,type:chart,obj:'int opackets:red:out')]|[(title:in bytes,type:chart,obj:'int ibytes:blue:in')|(title:out bytes,type:chart,obj:'int obytes:red:out')]]" loop=1

---

125

📖 Grid | Mac

Shows a grid with the Mac storage metrics and 4 charts for read, write IOPS and read, write bytes per second

# opack install mac
sudo powermetrics --help > /dev/null
oafp libs=Mac cmd="sudo powermetrics --format=plist --show-initial-usage -n 0 --samplers disk" in=plist path=disk out=grid grid="[[(title:data,path:@,xsnap:2)]|[(title:read iops,type:chart,obj:'dec3 rops_per_s:blue:read_iops')|(title:write iops,type:chart,obj:'dec3 wops_per_s:red:write_iops')]|[(title:read bytes per sec,type:chart,obj:'bytes rbytes_per_s:blue:read_bytes_per_sec')|(title:write bytes per sec,type:chart,obj:'bytes wbytes_per_s:red:write_bytes_per_sec')]]" loop=1

---

126

📖 Grid | Unix

On an Unix/Linux system supporting 'ps' output formats %cpu and %mem, will output a chart with the percentage of cpu and memory usage of a provided pid (e.g. 12345)

oafp cmd="ps -p 12345 -o %cpu,%mem" in=lines linesvisual=true linesvisualsepre="\\s+" out=chart chart="int '\"%CPU\"':red:cpu '\"%MEM\"':blue:mem -min:0 -max:100" loop=1 loopcls=true

---

127

📖 JSON Schemas | Lists

Get a list of JSON schemas from Schema Store catalog

oafp cmd="curl https://raw.githubusercontent.com/SchemaStore/schemastore/master/src/api/json/catalog.json" path="schemas[].{name:name,description:description,files:to_string(fileMatch)}" out=ctable

---

128

📖 Java | Certificates

Given a Java keystore will obtain a list of certificates and output them order by the ones that will expire first.

# execute 'ojob ojob.io/java/certs -jobhelp' to get more options
ojob ojob.io/java/certs op=list keystore=mycerts -json | oafp out=ctable sql="select * order by notAfter"

---

129

📖 Java | JFR

Convert the input of viewing allocation by site from a Java Flight Recorder (JFR) recording into a CSV output

jfr view allocation-by-site test.jfr | tail -n+4 | oafp in=lines linesvisual=true linesjoin=true out=csv from="notStarts(Method, '--')"

---

130

📖 Java | JFR

Given a Java Flight Recorder (JFR) recording produce a table order by class object allocation weigtht and count

oafp record.jfr path="[?name==\`jdk.ObjectAllocationSample\`].{time:startTime,class:fields.objectClass.name,weight:fields.weight}" jfrjoin=true sql='select "class", sum("weight") "sweight", count(1) "count" group by "class" order by "sweight" desc' out=ctable 

---

131

📖 Kubernetes | Base64

Given a Kubernetes Config Map or Secret with binary data, retrieves it and stores it locally in a binary file.

FILE=config.zip && kubectl get cm my-configs -n kube-system -o json | oafp path="binaryData.\"$FILE\"" | base64 -d > $FILE

---

132

📖 Kubernetes | Containers

Parse the Linux cgroup cpu stats on a container running in Kubernetes

cat /sys/fs/cgroup/cpu.stat | sed 's/ /: /g' | oafp in=yaml out=ctree

---

133

📖 Kubernetes | Helm

Given an Helm release name and the corresponding namespace will produce a table with the timestamps when the corresponding Helm chart hooks have started and completed for the lastest execution and the corresponding phase.

RELEASE=myrelease && NS=my-namespace && oafp cmd="helm status $RELEASE -n $NS -o json" out=ctable path="hooks[].{hookName:name,started_at:to_date(last_run.started_at),completed_at:to_date(last_run.completed_at),elapsed:from_ms(sub(to_number(to_ms(to_date(last_run.completed_at))),to_number(to_ms(to_date(last_run.started_at)))),''),phase:last_run.phase}"

---

134

📖 Kubernetes | Kubectl

Build a table of the images 'cached' in all Kubernetes nodes using Kubectl and, additionally, provide a summary of the total size per node.

# Master table with all nodes
oafp cmd="kubectl get nodes -o json" path="items[].amerge(status.images,{node:metadata.name})[].{node:node,image:names[1],sizeBytes:sizeBytes}" 
# Summary table of total images size per node
oafp cmd="kubectl get nodes -o json" path="items[].amerge(status.images,{node:metadata.name})[].{node:node,image:names[1],sizeBytes:sizeBytes}" sql='select "node", sum("sizeBytes") "totalSize" group by "node"' out=json | oafp field2byte=totalSize out=ctable

---

135

📖 Kubernetes | Kubectl

Build an output table with Kubernetes pods with namespace, pod name, container name and corresponding resources using kubectl

kubectl get pods -A -o json | oafp path="items[].amerge({ ns: metadata.namespace, pod: metadata.name, phase: status.phase }, spec.containers[].{ container: name, resources: to_slon(resources) })[]" sql="select ns, pod, container, phase, resources order by ns, pod, container" out=ctable

---

136

📖 Kubernetes | Kubectl

Build an output table with Kubernetes pods with node, namespace, pod name, container name and corresponding resources using kubectl

kubectl get pods -A -o json | oafp path="items[].amerge({ node: spec.nodeName, ns: metadata.namespace, pod: metadata.name, phase: status.phase }, spec.containers[].{ container: name, resources: to_slon(resources) })[]" sql="select node, ns, pod, container, phase, resources order by node, ns, pod, container" out=ctable

---

137

📖 Kubernetes | Kubectl

Executes a recursive file list find command in a specific pod, namespace and path converting the result into a table.

NS=default && POD=my-pod-5c9cfb87d4-r6dlp && LSPATH=/data && kubectl exec -n $NS $POD -- find $LSPATH -exec stat -c '{"t":"%F", "p": "%n", "s": %s, "m": "%Y", "e": "%A", "u": "%U", "g": "%G"}' {} \; | oafp in=ndjson ndjsonjoin=true path="[].{type:t,permissions:e,user:u,group:g,size:s,modifiedDate:to_date(mul(to_number(m),\`1000\`)),filepath:p}" from="sort(type,filepath)" out=ctable

---

138

📖 Kubernetes | Kubectl

Given a pod on a namespace loop through kubectl top and show a grid of two charts with the corresponding cpu and memory values.

NS=my-namespace && POD=my-pod-123dbf4dcb-d6jcc && oafp cmd="kubectl top -n $NS pod $POD" in=lines linesvisual=true path="[].{name:NAME,cpu:from_siAbbr(\"CPU(cores)\"),mem:from_bytesAbbr(\"MEMORY(bytes)\")}" out=grid grid="[[(title: cpu, type: chart, obj: 'dec3 cpu:blue:cpu -min:0')|(title: mem, type: chart, obj: 'bytes mem:green:mem -min:0')]]" loop=2 loopcls=true

---

139

📖 Kubernetes | Kubectl

Given the list of all Kubernetes objects will produce a list of objects per namespace, kind, apiVersiom, creation timestamp, name and owner.

oafp cmd="kubectl get all -A -o json" path="items[].{ns:metadata.namespace,kind:kind,apiVersion:apiVersion,createDate:metadata.creationTimestamp,name:metadata.name,owner:metadata.join(',',map(&concat(kind, concat('/', name)), nvl(ownerReferences,from_json('[]'))))}" sql="select * order by ns, kind, name" out=ctable

---

140

📖 Kubernetes | Kubectl

List of Kubernetes CPU, memory and storage stats per node using kubectl

oafp cmd="kubectl get nodes -o json" path="items[].{node:metadata.name,totalCPU:status.capacity.cpu,allocCPU:status.allocatable.cpu,totalMem:to_bytesAbbr(from_bytesAbbr(status.capacity.memory)),allocMem:to_bytesAbbr(from_bytesAbbr(status.allocatable.memory)),totalStorage:to_bytesAbbr(from_bytesAbbr(status.capacity.\"ephemeral-storage\")),allocStorage:to_bytesAbbr(to_number(status.allocatable.\"ephemeral-storage\")),conditions:join(\`, \`,status.conditions[].reason)}" output=ctable

---

141

📖 Kubernetes | Kubectl

List of Kubernetes pods per namespace and kind using kubectl

oafp cmd="kubectl get pods -A -o json" path="items[].{ns:metadata.namespace,kind:metadata.ownerReferences[].kind,name:metadata.name,status:status.phase,restarts:sum(nvl(status.containerStatuses[].restartCount,from_slon('[0]'))),node:spec.nodeName,age:timeago(nvl(status.startTime,now(\`0\`)))}" sql="select * order by status,name" output=ctable

---

142

📖 Kubernetes | Kubectl

Produces a list of pods' containers per namespace with the corresponding images and assigned nodes.

kubectl get pods -A -o json | oafp path="items[].amerge({namespace: metadata.namespace, pod: metadata.name, nodeName: spec.nodeName},spec.containers[].{container: name, image: image, pullPolicy: imagePullPolicy})[]" sql="select namespace, pod, container, image, pullPolicy, nodeName order by namespace, pod, container" out=ctable

---

143

📖 Kubernetes | Kubectl

Using kubectl with the appropriate permissions check the filesystem available, capacity and used bytes and inodes on each node of the Kubernetes cluster.

oafp cmd="kubectl get nodes -o json" in=json path="items[].metadata.name" out=cmd outcmd="kubectl get --raw '/api/v1/nodes/{}/proxy/stats/summary' | oafp out=json path=\"node.fs.insert(@,'node','{}')\"" outcmdparam=true | oafp in=ndjson ndjsonjoin=true  out=ctable

---

144

📖 Kubernetes | PVC

Produces a table with all Kubernetes persistent volume claims (PVCs) in use by pods.

oafp cmd="kubectl get pods -A -o json" path="items[].spec.set(@,'m').volumes[?persistentVolumeClaim].insert(@,'pname',get('m').containers[0].name).insert(@,'node',get('m').nodeName) | [].{pod:pname,node:node,pvc:persistentVolumeClaim.claimName}" from="sort(node,pod)" out=ctable

---

145

📖 Mac | Activity

Uses the Mac terminal command 'last' output to build an activity table with user, tty, from, login-time and logout-time

oafp cmd="last --libxo json" path="\"last-information\".last" out=ctable

---

146

📖 Mac | Brew

List all the packages and corresponding versions installed in a Mac by brew.

brew list --versions | oafp in=lines linesjoin=true path="[].split(@,' ').{package:[0],version:[1]}|sort_by(@,&package)" out=ctable

---

147

📖 Mac | Chart

On a Mac OS produce a looping chart with the total percentage of current CPU usage.

oafp cmd="top -l 1 | grep 'CPU usage' | awk '{print \$3 + \$5}'" out=chart chart="int @:blue:CPU_Usage -min:0 -max:100" loop=2 loopcls=true

---

148

📖 Mac | Info

Get a list of the current logged users in Mac OS

oafp cmd="who -aH" in=lines linesvisual=true linesjoin=true out=ctable path="[0:-1]"

---

149

📖 Mac | Info

Parses the current Mac OS hardware information

system_profiler SPHardwareDataType -json | oafp path="SPHardwareDataType[0]" out=ctree

---

150

📖 Mac | Info

Parses the current Mac OS overview information

system_profiler SPSoftwareDataType -json | oafp path="SPSoftwareDataType[0]" out=ctree

---

151

📖 Mac | Safari

Get a list of all Mac OS Safari bookmarks into a CSV file.

# opack install mac
oafp ~/Library/Safari/Bookmarks.plist libs=Mac path="Children[].map(&{category:get('cat'),title:URIDictionary.title,url:URLString},setp(@,'Title','cat').nvl(Children,from_json('[]')))[][]" out=csv > bookmarks.csv

---

152

📖 Mac | Tunnelblink

In a Mac OS with Tunnelblink, if you want to copy all your OpenVPN configurations into ovpn files.

oafp in=ls data="$HOME/Library/Application Support/Tunnelblick/Configurations" path="[?filename=='config.ovpn'].insert(@,'name',replace(filepath,'.+\/([^\/]+)\.tblk\/.+','','\$1'))" lsrecursive=true out=cmd outcmdtmpl=true outcmd="cp \"\" output/\".ovpn\""

---

153

📖 Markdown | Tables

For an input markdown file, parse all tables, transform it to JSON and output as a colored table

oafp url="https://raw.githubusercontent.com/OpenAF/sh/refs/heads/main/README.md" in=mdtable inmdtablejoin=true path="[0]" out=ctable

---

154

📖 Network | ASN

Retrieve an IP to ASN list list and converts it to ndjson

oafp cmd="curl https://api.iptoasn.com/data/ip2asn-combined.tsv.gz | gunzip" in=lines linesjoin=true path="[?length(@)>'0'].split(@,'\t').{start:[0],end:[1],asn:[2],area:[3],name:[4]}" out=ndjson

---

155

📖 Network | ASN

Retrieve the list of ASN number and names from RIPE and transforms it to a CSV.

oafp url="https://ftp.ripe.net/ripe/asnames/asn.txt" in=lines linesjoin=true path="[?length(@)>'0'].split(@,' ').{asn:[0],name:join(' ',[1:])}" out=csv

---

156

📖 Network | Latency

Given a host and a port will display a continuously updating line chart with network latency, in ms, between the current device and the target host and port

HOST=1.1.1.1 && PORT=53 && oafp in=oaf data="data=ow.loadNet().testPortLatency('$HOST',$PORT)" out=chart chart="int @:red:latencyMS -min:0" loop=1 loopcls=true

---

157

📖 Ollama | List models

Parses the list of models currently in an Ollama deployment

export OAFP_MODEL="(type: ollama, model: 'llama3', url: 'https://models.local', timeout: 900000)"
oafp in=llmmodels data="()" out=ctable path="[].{name:name,parameters:details.parameter_size,quantization:details.quantization_level,format:details.format,family:details.family,parent:details.parent,size:size}" sql="select * order by parent,family,format,parameters,quantization"

---

158

📖 OpenAF | Channels

Copy the json result of a command into an etcd database using OpenAF's channels

oaf -c "\$o(io.listFiles('.').files,{__format:'json'})" | oafp out=ch ch="(type: etcd3, options: (host: localhost, port: 2379), lib: 'etcd3.js')" chkey=canonicalPath

---

159

📖 OpenAF | Channels

Getting all data stored in an etcd database using OpenAF's channels

echo "" | oafp in=ch inch="(type: etcd3, options: (host: localhost, port: 2379), lib: 'etcd3.js')" out=ctable

---

160

📖 OpenAF | Channels

Given a Prometheus database will query for a specific metric (go_memstats_alloc_bytes), during a defined period, every 5 seconds (step) will produce a static chart with the corresponding metric values.

URL="http://localhost:9090" && METRIC="go_memstats_alloc_bytes" && TYPE="bytes" && LABELS="job=\"prometheus\"" && START="2024-06-18T20:00:00Z" && END="2024-06-18T20:15:00Z" && STEP=5 && echo "{query:'max($METRIC{$LABELS})',start:'$START',end:'$END',step:$STEP}" | oafp in=ch inch="(type:prometheus,options:(urlQuery:'$URL'))" inchall=true out=json | oafp path="[].set(@, 'main').map(&{metric:'$METRIC',job:get('main').metric.job,timestamp:to_date(mul([0],\`1000\`)),value:to_number([1])}, values) | []" out=schart schart="$TYPE '[].value':green:$METRIC -min:0"

---

161

📖 OpenAF | Channels

Perform a query to a metric & label, with a start and end time, to a Prometheus server using OpenAF's channels

oafp in=ch inch="(type:prometheus,options:(urlQuery:'http://prometheus.local'))" inchall=true data="(start:'2024-03-22T19:00:00.000Z',end:'2024-03-22T19:05:00.000Z',step:60,query:go_memstats_alloc_bytes_total{job=\"prometheus\"})" path="[].values[].{date:to_date(mul([0],to_number('1000'))),value:[1]}" out=ctable

---

162

📖 OpenAF | Channels

Retrieve all keys stores in a H2 MVStore file using OpenAF's channels

echo "" | oafp in=ch inch="(type: mvs, options: (file: data.db))" out=ctable

---

163

📖 OpenAF | Channels

Store and retrieve data from a Redis database

# Install rocksdb opack: 'opack install redis'
#
# Storing data
oafp cmd="oaf -c \"sprint(listFilesRecursive('/usr/bin'))\"" out=ch ch="(type: redis, lib: redis.js, options: (host: '127.0.0.1', port: 6379))" chkey=canonicalPath
# Retrieve data
echo "" | oafp in=ch inch="(type: redis, lib: redis.js, options: (host: '127.0.0.1', port: 6379))" out=pjson

---

164

📖 OpenAF | Channels

Store and retrieve data from a RocksDB database

# Install rocksdb opack: 'opack install rocksdb'
#
# Storing data
oafp cmd="oaf -c \"sprint(listFilesRecursive('/usr/bin'))\"" out=ch ch="(type: rocksdb, lib: rocksdb.js, options: (path: db))" chkey=canonicalPath
# Retrieve data
echo "" | oafp in=ch inch="(type: rocksdb, lib: rocksdb.js, options: (path: db))" out=pjson

---

165

📖 OpenAF | Channels

Store the json results of a command into a H2 MVStore file using OpenAF's channels

oaf -c "\$o(listFilesRecursive('.'),{__format:'json'})" | oafp out=ch ch="(type: mvs, options: (file: data.db))" chkey=canonicalPath

---

166

📖 OpenAF | Flags

List the current values of OpenAF/oAFp internal flags

oafp in=oaf data="data=__flags"

---

167

📖 OpenAF | Network

Gets all the DNS host addresses for a provided domain and ensures that the output is always a list

DOMAIN="nattrmon.io" && oafp in=oaf data="data=ow.loadNet().getDNS('$DOMAIN','a',__,true)" path="if(type(@)=='array',[].Address.HostAddress,[Address.HostAddress]).map(&{ip:@},[])" out=ctable

---

168

📖 OpenAF | Network

List all MX (mail servers) network addresses from the current DNS server for a hostname using OpenAF

DOMAIN=gmail.com && TYPE=MX && oaf -c "sprint(ow.loadNet().getDNS('$DOMAIN','$TYPE'))" | oafp from="sort(Address)" out=ctable

---

169

📖 OpenAF | Network

List all network addresses returned from the current DNS server for a hostname using OpenAF

DOMAIN=yahoo.com && oaf -c "sprint(ow.loadNet().getDNS('$DOMAIN'))" | oafp from="sort(Address)" out=ctable

---

170

📖 OpenAF | OS

Current OS information visible to OpenAF

oafp -v path=os

---

171

📖 OpenAF | OS

Using OpenAF parse the current environment variables

oaf -c "sprint(getEnvs())" | oafp sortmapkeys=true out=ctree

---

172

📖 OpenAF | OpenVPN

Using OpenAF code to perform a more complex parsing of the OpenVPN status data running on an OpenVPN container (nmaguiar/openvpn) called 'openvpn'

oafp in=oaf data='data=(function(){return(b=>{var a=b.split("\n"),c=a.indexOf("ROUTING TABLE"),d=a.indexOf("GLOBAL STATS"),f=a.indexOf("END");b=$csv().fromInString($path(a,`[2:${c}]`).join("\n")).toOutArray();var g=$csv().fromInString($path(a,`[${c+1}:${d}]`).join("\n")).toOutArray();a=$csv().fromInString($path(a,`[${d+1}:${f}]`).join("\n")).toOutArray();return{list:b.map(e=>merge(e,$from(g).equals("Common Name",e["Common Name"]).at(0))),stats:a}})($sh("docker exec openvpn cat /tmp/openvpn-status.log").get(0).stdout)})()' path="list[].{user:\"Common Name\",ip:split(\"Real Address\",':')[0],port:split(\"Real Address\",':')[1],vpnAddress:\"Virtual Address\",bytesRx:to_bytesAbbr(to_number(\"Bytes Received\")),bytesTx:to_bytesAbbr(to_number(\"Bytes Sent\")),connectedSince:to_datef(\"Connected Since\",'yyyy-MM-dd HH:mm:ss'),lastReference:to_datef(\"Last Ref\",'yyyy-MM-dd HH:mm:ss')}" sql="select * order by lastReference" out=ctable

---

173

📖 OpenAF | SFTP

Generates a file list with filepath, size, permissions, create and last modified time from a SFTP connection with user and password

HOST="my.server" && PORT=22 && LOGIN="user" && PASS=$"abc123" && LSPATH="." && oaf -c "sprint(\$ssh({host:'$HOST',login:'$LOGIN',pass:'$PASS'}).listFiles('$LSPATH'))" | oafp out=ctable path="[].{isDirectory:isDirectory,filepath:filepath,size:size,createTime:to_date(mul(createTime,\`1000\`)),lastModified:to_date(mul(lastModified,\`1000\`)),permissions:permissions}" from="sort(-isDirectory,filepath)"

---

174

📖 OpenAF | SFTP

Generates a file list with filepath, size, permissions, create and last modified time from a SFTP connection with user, private key and password

HOST="my.server" && PORT=22 && PRIVID=".ssh/id_rsa" && LOGIN="user" && PASS=$"abc123" && LSPATH="." && oaf -c "sprint(\$ssh({host:'$HOST',login:'$LOGIN',pass:'$PASS',id:'$PRIVID'}).listFiles('$LSPATH'))" | oafp out=ctable path="[].{isDirectory:isDirectory,filepath:filepath,size:size,createTime:to_date(mul(createTime,\`1000\`)),lastModified:to_date(mul(lastModified,\`1000\`)),permissions:permissions}" from="sort(-isDirectory,filepath)"

---

175

📖 OpenAF | TLS

List the TLS certificates of a target host with a sorted alternative names using OpenAF

DOMAIN=yahoo.com && oaf -c "sprint(ow.loadNet().getTLSCertificates('$DOMAIN',443))" | oafp path="[].{issuer:issuerDN,subject:subjectDN,notBefore:notBefore,notAfter:notAfter,alternatives:join(' | ',sort(map(&[1],nvl(alternatives,\`[]\`))))}" out=ctree

---

176

📖 OpenAF | oJob.io

Parses ojob.io/news results into a clickable news title HMTL page.

ojob ojob.io/news/awsnews __format=json | oafp path="[].{title:replace(t(@,'[]()'),'\|','g','\\|'),date:date}" from="sort(-date)" out=mdtable | oafp in=md out=html

---

177

📖 OpenAF | oJob.io

Retrieves the list of oJob.io's jobs and filters which start by 'ojob.io/news' to display them in a rectangle

oafp url="https://ojob.io/index.json" path="sort(init.l)[].replace(@,'^https://(.+)\.(yaml|json)$','','\$1')|[?starts_with(@, 'ojob.io/news')]" out=map

---

178

📖 OpenAF | oPacks

Given a folder of expanded oPacks folders will process each folder .package.yaml file and join each corresponding oPack name and dependencies into a sinlge output map.

oafp in=oafp data="(in:ls,data:.,path:'[?isDirectory].concat(canonicalPath,\`/.package.yaml\`)')" out=cmd outcmd="oafp {} out=json" outcmdparam=true | oafp in=ndjson ndjsonjoin=true path="[].{name:name,deps:dependencies}"

---

179

📖 OpenAF | oPacks

Listing all currently accessible OpenAF's oPacks

oaf -c "sprint(getOPackRemoteDB())" | oafp maptoarray=true opath="[].{name:name,description:description,version:version}" from="sort(name)" out=ctable

---

180

📖 OpenAF | oafp

Filter the OpenAF's oafp examples list by a specific word in the description

oafp url="https://ojob.io/oafp-examples.yaml" in=yaml out=template path=data templatepath=tmpl sql="select * where d like '%something%'"

---

181

📖 OpenAF | oafp

List the OpenAF's oafp examples by category, sub-category and description

oafp url="https://ojob.io/oafp-examples.yaml" in=yaml path="data[].{category:c,subCategory:s,description:d}" from="sort(category,subCategory,description)" out=ctable

---

182

📖 OpenAF | oafp

Produce a colored table with all the current oafp input and output formats supported.

oafp -v path="concat(oafp.inputs[].{option:'in',type:@}, oafp.outputs[].{option:'out',type:@})" out=ctable

---

183

📖 OpenVPN | List

When using the container nmaguiar/openvpn it's possible to convert the list of all clients order by expiration/end date

oafp cmd="docker exec openvpn ovpn_listclients" in=csv path="[].{name:name,begin:to_datef(begin,'MMM dd HH:mm:ss yyyy z'),end:to_datef(end,'MMM dd HH:mm:ss yyyy z'),status:status}" out=ctable sql="select * order by end desc"

---

184

📖 QR | Encode JSON

Given a JSON input encode and decote it from a QR-code png file.

# opack install qr
# Encoding an input into qr.png
oafp in=ls data="." out=json sql="select filepath, size limit 20" | oafp libs=qr in=raw out=qr qrfile=qr.png
# Decoding a qr.png back to json
oafp libs=qr in=qr data=qr.png out=raw | oafp in=json out=ctable

---

185

📖 QR | Read QR-code

Given a QR-code png file output the corresponding contents.

# opack install qr
oafp libs=qr in=qr data=qr.png out=raw

---

186

📖 QR | URL

Generate a QR-code for a provided URL.

# opack install qr
oafp libs=qr in=raw data="https://oafp.io" out=qr qrfile=qr.png

---

187

📖 Unix | Activity

Uses the Linux command 'last' output to build a table with user, tty, from and period of activity for Debian based Linuxs

oafp cmd="last" in=lines linesjoin=true path="[:-3]|[?contains(@,'no logout')==\`false\`&&contains(@,'system boot')==\`false\`].split_re(@,' \\s+').{user:[0],tty:[1],from:[2],period:join(' ',[3:])}" out=ctable

---

188

📖 Unix | Activity

Uses the Linux command 'last' output to build a table with user, tty, from and period of activity for RedHat based Linuxs

last | sed '/^$/d;$d;$d' | oafp in=lines linesjoin=true path="[].split_re(@, '\\s+').{user: [0], tty: [1], from: [2], login_time: join(' ', [3:7])}" out=ctable

---

189

📖 Unix | Alpine

List all installed packages in an Alpine system

apk list -I | oafp in=lines linesjoin=true path="[].replace(@,'(.+) (.+) {(.+)} \((.+)\) \[(.+)\]','','\$1|\$2|\$3|\$4').split(@,'|').{package:[0],arch:[1],source:[2],license:[3]}" out=ctable

---

190

📖 Unix | Ask

Unix bash script to ask for a path and choose between filetypes to perform an unix find command.

#!/bin/bash
temp_file=$(mktemp)
oafp data="[\
  (name: path, prompt: 'Enter the path to search: ', type: question) |\
  (name: type, prompt: 'Choose the file type: ', type: choose, options: ['.jar'|'.class'|'.java'|'.js']) ]"\
     in=ask out=envs\
     arraytomap=true arraytomapkey=name envsnoprefix=true\
     outfile=$temp_file
source $temp_file

find "${path_answer:-.}" -type f -name "*$type_answer"

---

191

📖 Unix | Compute

Parses the Linux /proc/cpuinfo into an array

cat /proc/cpuinfo | sed "s/^$/---/mg" | oafp in=yaml path="[?not_null(@)]|[?type(processor)=='number']" out=ctree

---

192

📖 Unix | Debian/Ubuntu

List all installed packages in a Debian/Ubuntu system

apt list --installed | sed "1d" | oafp in=lines linesjoin=true path="[].split(@,' ').{pack:split([0],'/')[0],version:[1],arch:[2]}" out=ctable

---

193

📖 Unix | Envs

Converts the Linux envs command result into a table of environment variables and corresponding values

env | oafp in=ini path="map(&{key:@,value:to_string(get(@))},sort(keys(@)))" out=ctable

---

194

📖 Unix | Files

Converting the Linux's /etc/os-release to SQL insert statements.

oafp cmd="cat /etc/os-release" in=ini outkey=release path="[@]" sql="select '$HOSTNAME' \"HOST\", *" out=sql sqlnocreate=true

---

195

📖 Unix | Files

Converting the Unix's syslog into a json output.

cat syslog | oafp in=raw path="split(trim(@),'\n').map(&split(@, ' ').{ date: concat([0],concat(' ',[1])), time: [2], host: [3], process: [4], message: join(' ',[5:]) }, [])"

---

196

📖 Unix | Files

Executes a recursive file list find command converting the result into a table.

LSPATH=/openaf && find $LSPATH -exec stat -c '{"t":"%F", "p": "%n", "s": %s, "m": "%Y", "e": "%A", "u": "%U", "g": "%G"}' {} \; | oafp in=ndjson ndjsonjoin=true path="[].{type:t,permissions:e,user:u,group:g,size:s,modifiedDate:to_date(mul(to_number(m),\`1000\`)),filepath:p}" from="sort(type,filepath)" out=ctable

---

197

📖 Unix | Files

Parses the Linux /etc/passwd to a table order by uid and gid.

oafp cmd="cat /etc/passwd" in=csv inputcsv="(withHeader: false, withDelimiter: ':')" path="[].{user:f0,pass:f1,uid:to_number(f2),gid:to_number(f3),description:f4,home:f5,shell:f6}" out=json | oafp from="notStarts(user, '#').sort(uid, gid)" out=ctable

---

198

📖 Unix | Generic

Creates, in unix, a data.ndjson file where each record is formatted from json files in /some/data

find /some/data -name "*.json" -exec oafp {} output=json \; > data.ndjson

---

199

📖 Unix | Memory map

Given an Unix process will output a table with process's components memory address, size in bytes, permissions and owner

pmap 12345 | sed '1d;$d' | oafp in=lines linesjoin=true path="[].split_re(@, '\\s+').{address:[0],size:from_bytesAbbr([1]),perm:[2],owner:join('',[3:])}" out=ctable

---

200

📖 Unix | Network

Loop over the current Linux active network connections

oafp cmd="netstat -tun | sed \"1d\"" in=lines linesvisual=true linesjoin=true linesvisualsepre="\\s+(\\?\!Address)" out=ctable loop=1

---

201

📖 Unix | Network

Parse the Linux 'arp' command output

arp | oafp in=lines linesvisual=true linesjoin=true out=ctable

---

202

📖 Unix | Network

Parse the Linux 'ip tcp_metrics' command

ip tcp_metrics | sed 's/^/target: /g' | sed 's/$/\n\n---\n/g' | sed 's/ \([a-z]*\) /\n\1: /g' | head -n -2 | oafp in=yaml path="[].{target:target,age:from_timeAbbr(replace(age,'[sec|\.]','','')),cwnd:cwnd,rtt:from_timeAbbr(rtt),rttvar:from_timeAbbr(rttvar),source:source}" sql="select * order by target" out=ctable

---

203

📖 Unix | Network

Parse the result of the Linux route command

route | sed "1d" | oafp in=lines linesjoin=true linesvisual=true linesvisualsepre="\s+" out=ctable

---

204

📖 Unix | OpenSuse

List all installed packages in an OpenSuse system or zypper based system

zypper se -is | egrep "^i" | oafp in=lines linesjoin=true path="[].split(@,'|').{name:[1],version:[2],arch:[3],repo:[4]}" out=ctable

---

205

📖 Unix | RedHat

List all installed packages in a RedHat system or rpm based system (use rpm –querytags to list all fields available)

rpm -qa --qf "%{NAME}|%{VERSION}|%{PACKAGER}|%{VENDOR}|%{ARCH}\n" | oafp in=lines linesjoin=true path="[].split(@,'|').{package:[0],version:[1],packager:[2],vendor:[3],arch:[4]}" from="sort(package)" out=ctable

---

206

📖 Unix | Storage

Converting the Unix's df output

df --output=target,fstype,size,used,avail,pcent | tail -n +2 | oafp in=lines linesjoin=true path="[].split_re(@, ' +').{filesystem:[0],type:[1],size:[2],used:[3],available:[4],use:[5]}" out=ctable

---

207

📖 Unix | Storage

Parses the result of the Unix ls command

ls -lad --time-style="+%Y-%m-%d %H:%M" * | oafp in=lines path="map(&split_re(@,'\\s+').{permissions:[0],id:[1],user:[2],group:[3],size:[4],date:[5],time:[6],file:[7]},[])" linesjoin=true out=ctable

---

208

📖 Unix | SystemCtl

Converting the Unix's systemctl list-timers

systemctl list-timers | head -n -3 | oafp in=lines linesvisual=true linesjoin=true out=ctable

---

209

📖 Unix | SystemCtl

Converting the Unix's systemctl list-units

systemctl list-units | head -n -6 | oafp in=lines linesvisual=true linesjoin=true path="[].delete(@,'')" out=ctable

---

210

📖 Unix | SystemCtl

Converting the Unix's systemctl list-units into an overview table

systemctl list-units | head -n -6 | oafp in=lines linesvisual=true linesjoin=true path="[].delete(@,'')" sql="select \"LOAD\", \"ACTIVE SUB\", count(1) as \"COUNT\" group by \"LOAD\", \"ACTIVE SUB\"" sqlfilter=advanced out=ctable

---

211

📖 Unix | Threads

Given an unix process id (pid) loop a table with its top 25 most cpu active threads

JPID=12345 && oafp cmd="ps -L -p $JPID -o tid,pcpu,comm|tail +2" in=lines linesjoin=true path="[].split_re(trim(@),'\s+').{tid:[0],thread:join(' ',[2:]),cpu:to_number(nvl([1],\`-1\`)),cpuPerc:progress(nvl(to_number([1]),\`0\`), \`100\`, \`0\`, \`50\`, __, __)}" sql='select * order by cpu desc limit 25' out=ctable loop=1 loopcls=true

---

212

📖 Unix | UBI

List all installed packages in an UBI system

microdnf repoquery --setopt=cachedir=/tmp --installed | oafp in=lines linesjoin=true path="[].replace(@,'(.+)\.(\w+)\.(\w+)\$','','\$1|\$2|\$3').split(@,'|').{package:[0],dist:[1],arch:[2]}" out=ctable

---

213

📖 Unix | named

Converts a Linux's named log, for client queries, into a CSV

cat named.log | oafp in=lines linesjoin=true path="[?contains(@,' client ')==\`true\`].split(@,' ').{datetime:to_datef(concat([0],concat(' ',[1])),'dd-MMM-yyyy HH:mm:ss.SSS'),session:[3],sourceIP:replace([4],'(.+)#(\d+)','','\$1'),sourcePort:replace([4],'(.+)#(\d+)','','\$2'),target:replace([5],'\((.+)\):','','\$1'),query:join(' ',[6:])}" out=csv

---

214

📖 Unix | strace

Given a strace unix command will produce a summary table of the system calls invoked including a small line chart of the percentage of time of each.

strace -c -o '!oafp in=lines linesvisual=true linesjoin=true opath="[1:-2].merge(@,{perc:progress(to_number(\"% time\"),\`100\`,\`0\`,\`15\`,__,__)})" out=ctable' strace --tips

---

215

📖 VSCode | Extensions

Check a Visual Studio Code (vscode) extension (vsix) manifest.

oafp in=xml file="Org.my-extension.vsix::extension.vsixmanifest" out=ctree

---

216

📖 Windows | Network

Output a table with the current route table using Windows' PowerShell

Get-NetRoute | ConvertTo-Json | .\oafp.bat path="[].{destination:DestinationPrefix,gateway:NextHop,interface:InterfaceAlias,metric:InterfaceMetric}" sql=select\ *\ order\ by\ interface,destination out=ctable

---

217

📖 Windows | Network

Output a table with the list of network interfaces using Windows' PowerShell

Get-NetIPAddress | ConvertTo-Json | .\oafp.bat path="[].{ipAddress:IPAddress,prefixLen:PrefixLength,interface:InterfaceAlias}" sql=select\ *\ order\ by\ interface out=ctable

---

218

📖 Windows | PnP

Output a table with USB/PnP devices using Windows' PowerShell

Get-PnpDevice -PresentOnly | ConvertTo-Csv -NoTypeInformation | .\oafp.bat in=csv path="[].{class:PNPClass,service:Service,name:FriendlyName,id:InstanceId,description:Description,deviceId:DeviceID,status:Status,present:Present}" sql=select\ *\ order\ by\ class,service out=ctable

---

219

📖 Windows | Storage

Output a table with the attached disk information using Windows' PowerShell

Get-Disk | ConvertTo-Csv -NoTypeInformation | .\oafp.bat in=csv path="[].{id:trim(UniqueId),name:FriendlyName,isBoot:IsBoot,location:Location,size:to_bytesAbbr(to_number(Size)),allocSize:to_bytesAbbr(to_number(AllocatedSize)),sectorSize:LogicalSectorSize,phySectorSize:PhysicalSectorSize,numPartitions:NumberOfPartitions,partitioning:PartitionStyle,health:HealthStatus,bus:BusType,manufacturer:Manufacturer,model:Model,firmwareVersion:FirmwareVersion,serialNumber:SerialNumber}" out=ctable

---

220

📖 XML | Maven

Given a Maven pom.xml parses the XML content to a colored table ordering by the fields groupId and artifactId.

oafp pom.xml path="project.dependencies.dependency" out=ctable sql="select * order by groupId, artifactId"

---

221

📖 nAttrMon | Plugs

Given a nAttrMon config folder, with YAML files, produce a summary table with the each plug (yaml file) execFrom definition.

oafp cmd="grep -R execFrom" in=lines path="[].split(@,':').{plug:[0],execFrom:[2]}" linesjoin=true out=ctable sql="select execFrom, plug where plug <> '' order by execFrom"