Overview

OSL keeps the core language small and ships capabilities as a standard library of packages. You pull in what you need with import:

import "osl/fs"

log fs.readFile("notes.txt")

Each package exposes a single global value named after the package (fs, crypto, serve, …) whose methods you call. The osl/ prefix is optional for standard-library packages - import "fs" and import "osl/fs" are equivalent.

How imports work

Form	Meaning
import "osl/fs" / import "fs"	A standard-library package (listed below).
import "./helpers.osl"	Another OSL file in your project (path relative to the current file).
import "go/net/http"	A raw Go package, for advanced interop.

Missing third-party Go dependencies are fetched automatically when you compile.

Returned objects

Some packages give you an object to keep working with. For example, db.open() returns a database handle, and you call further methods on that:

import "osl/db"

*db.DB handle = db.open("app.db")
handle.exec("CREATE TABLE users (id INTEGER, name TEXT)")
array rows = handle.query("SELECT * FROM users")

On each package page these are listed under "Returned object" headings.

The standard library at a glance

Web & networking

Package	Description
serve	HTTP server / web framework (routing, middleware, contexts).
ws	WebSocket client and server.
originchats	Bot framework for OriginChats servers.
requests	HTTP client (get/post/put/…).
net	Low-level TCP/UDP sockets and DNS lookups.
url	URL parsing, building and query-string handling.
ftp	FTP file transfers.
ssh	SSH connections, remote commands and SCP.
s3	S3-compatible object storage client.
webpush	Web Push notifications (VAPID).

Data & serialization

Package	Description
json	JSON parsing and encoding.
yaml	YAML parsing and encoding.
csv	CSV parsing plus a small dataframe-style toolkit.
xml	XML parsing and querying.
template	Lightweight {{ }} templating with HTML escaping.
mime	MIME-type lookup and parsing.
diff	Text/line/word diffing.

Databases & storage

Package	Description
db	Embedded SQLite - SQL plus a document/collection API.
save	Simple persistent key-value storage.
cache	In-memory LRU cache with TTLs.
env	Environment variables and .env files.

Filesystem & system

Package	Description
fs	Files, directories and path utilities.
sys	System info, environment, and running shell commands.
process	Spawn, manage and signal processes.
zip	ZIP / TAR / GZIP compression.

Crypto & security

Package	Description
crypto	Hashing, HMAC, AES, password hashing, file encryption, random.
jwt	JSON Web Token signing and verification.

Text, math & time

Package	Description
regex	Regular expressions plus validators and text helpers.
semver	Semantic-version parsing and comparison.
math	Maths, statistics and number theory.
random	Seedable pseudo-random numbers.
date	Dates, durations and time zones.
cron	Cron-style job scheduling.

Terminal & logging

Package	Description
tui	Terminal UI: colours, boxes, tables, prompts, menus, charts.
log	Levelled, colourful logging.
notify	Desktop notifications.

Media & documents

Package	Description
img	Load, transform and save images.
qr	QR codes and barcodes.
pdf	Generate PDF documents.
canvas	In-memory pixel canvas.
colors	Build colour values (used by image-producing packages).
sound	Audio playback.

Graphics & windowing

Package	Description
window	Open a window and draw to it (the originOS graphics model).

Scripting & concurrency

Package	Description
lua	Embed and run Lua scripts.
thread	Background threads.
sync	Named locks for synchronisation.

Utilities & data structures

Package	Description
map	An ordered key-value map type.
set	A set type.
option	Optional values (some/none).
result	Success/error result values.
ptr	Low-level pointer operations.

More

Package	Description
email	Compose and send email (SMTP).
torrent	Create and parse .torrent files.

---

To read a package's source directly from the CLI:

osl package fs       # print the fs package source
osl package          # list every available package