Velaris
An AI wrote you a script. Run it anyway.
A language where a function's signature declares what it may touch — and the runtime refuses anything you did not allow, whatever the code says about itself.
Playground · Documentation · Reference · Library · Errors
pip install velaris-lang
velaris agent_output.vel
That program cannot open a socket, read a file, call Python, or ask the clock. Not "shouldn't" — the runtime refuses, and a refusal cannot be caught and carried past. You do not have to read the code, understand it, or trust the compiler's analysis of it.
Since 5.0 that is what a run with no --allow gets: io, the
console. It used to be all seven effects, which meant the answer to
"what may this program do?" was "everything" until an operator said
otherwise. Widen it by naming what the program needs
(--allow io,fs:read:./data); --allow all grants every effect and
writes one line to stderr saying so.
--allow io,ffi:math,json grants Python for those modules only; a call
that reaches any other module — named, or reached through an attribute of
a granted one — is refused (E311). A granted module can still do whatever
that module itself can do: ffi:os is the operating system. Since 3.0
the same grammar
narrows every coarse effect: fs:read:./data, fs:write:./out,
net:api.example.com:443, net:*.example.com, and @100 for at most
that many operations in a run; env is its own effect, so an
io-only program cannot read the environment. timeout and
max_memory_mb are available through the library and every door, and
on a door the operator's limits are ceilings a caller cannot raise.
It is still not a security boundary - but the
caveats every review raised, the ffi cliff, unbounded execution, and
fs and net with no path or host list, are now precise permissions
rather than holes. It is a real guard for the situation everyone is
now in — running a program someone, or something, else wrote.
The other half: promises, proven
fn discount(price: Int) -> Int
requires price >= 0
ensures result >= 0
{
return price - 10
}
error[E700] promise cannot be kept: 'discount' ensures result >= 0
proven without running the program: price = 5 gives result = -5
That ensures is not a comment or a runtime assert. The Z3 theorem
prover verifies it for every possible input before execution — and
refutes it with an exact counterexample when it lies.
A rule the customer wrote
A commerce platform lets each customer write their own discount rule. This one has the shape most of them have: a percentage off once the basket passes a threshold, a flat amount off as well, and a cap on the two together.
record Rule {
percent: Int // this much off, once the basket is
above: Money of INR // worth at least this,
flat: Money of INR // and this much off as well,
cap: Money of INR // but never more than this, all together
}
fn discount_for(total: Money of INR, rule: Rule) -> Money of INR
requires total >= money(0, "INR")
requires rule.percent >= 0
requires rule.percent <= 100
requires rule.flat >= money(0, "INR")
requires rule.cap >= money(0, "INR")
ensures result >= money(0, "INR")
ensures total - result >= money(0, "INR")
{
let off = money(0, "INR")
if total >= rule.above {
off = percent_of(total, rule.percent, 100, "half_up")
}
off = off + rule.flat
if off > rule.cap {
off = rule.cap
}
if off > total {
off = total
}
return off
}
The two ensures are what the platform needs to know about a rule it
did not write: a discount is never a surcharge, and what is left after
it is never negative. Both are settled for every basket and every rule
the types allow, before the program runs.
examples/discount.vel is the whole program —
five of five functions proven, and it runs under --allow io.
examples/discount_bad.vel is the same
rule with the last if deleted. The cap still holds the discount to a
fixed ceiling; nothing holds it to what the basket is worth:
$ velaris check examples/discount_bad.vel
examples/discount_bad.vel:54: [E700] promise cannot be kept: 'discount_for' ensures total - result >= money(0, "INR") - proven without running the program: rule = Rule(percent: 0, above: 0, flat: 2, cap: 1), total = 0 gives result = 1
The amounts are in paise: a basket worth nothing, a flat discount of two paise held down to a cap of one, and one paisa handed back anyway. The program does not run.
A sandbox answers a different question. It can stop this rule reading a file or opening a socket; it cannot tell you whether the arithmetic holds.
A key it cannot print
Effects say a program printed something. They do not say whether what
it printed was the secret. Secret of T (6.0, 7.0) is the other half: the
compiler tracks the value, and refuses any program that hands it to
anything that emits.
fn key() -> Secret of Text uses env {
return env("API_KEY", "") // env() gives a Secret of Text
}
fn authorization(k: Secret of Text) -> Secret of Text {
return "Bearer " + k // still a Secret of Text
}
examples/secret.vel reads an API key, builds
the request that would carry it, and prints a summary of that request.
examples/secret_bad.vel is the same
program with one more line:
$ velaris examples/secret_bad.vel --allow env,io
error[E560] argument 1 of 'print' is Secret of Text, and 'print' performs io - a Secret cannot be printed, written, sent or passed to Python. It came from env(), line 27, through 'key', which returns Secret of Text (line 58)
--> examples/secret_bad.vel, line 58
Nothing ran, nothing was logged, and no reviewer had to notice the
line. A list of secrets, a map of them, or a record with one secret
field carries it too, so the whole structure is refused at a sink — a
Request record holding the key cannot be printed either.
And a program cannot look at the key either. key == "" is a
Secret of Bool, not a Bool, and an if or while on one is
E563. That is the rule that makes the rest mean something: with
length and code_at, a plain Bool from == is not one bit, it is
a loop that reads the whole key out —
while at < 3 {
for c in alphabet {
if code_at(key, at) == code_at(c, 0) { // E563
found = found + c
}
}
at = at + 1
}
print("recovered: " + found) // the whole key
— so a rule that stopped print(key) and allowed that would be a
decoration, not a type. The line is drawn at the branch.
declassify(value, "why") is the only way out. It needs
uses declassify in the signature, a reason written in the call, and
the declassify grant at run time — and it is what the audit reports,
so a consumer can ask whether a program ever lets a secret out without
running it:
$ velaris audit examples/secret.vel --json | jq .secrets
{
"sources": ["env"],
"declassifies": false,
"declassifications": []
}
To look at a secret, a program says so — declassify(key == "", "…")
gives back a Bool you can branch on, at the cost of the effect, the
grant and a reason in the audit. That is the trade: not silence, a
statement.
What this does not do: it only sees values env() and
read_file_secret() produced, so a password read with read_line, or
handed in through args(), or fetched from a vault over net, is an
ordinary Text with no protection at all. And it is not
non-interference — a program still chooses how long to run and whether
to stop. SPEC.md §3.1 states the rules and
THREAT_MODEL.md states the limits.
Related work
TACIT ("Securing Agents With
Tracked Capabilities", ACM CAIS '26;
arXiv 2603.00991) has agents write
Scala 3, whose capture checking tracks file, network and command
capabilities as values in the type system;
CaMeL has a model turn the user's
request into a restricted subset of Python and tags every value with its
provenance and permitted readers, checking a policy at each tool call;
WASI gives a WebAssembly module only the resources
its host hands it. Velaris is a small language a model learns from a
3,700-word card, in which functions declare their effects, the runtime
enforces the operator's budget at each operation, and contracts are
checked by the Z3 theorem prover. From 6.0 it also tracks one kind of
data: Secret of T, which env() and read_file_secret() produce and
which cannot reach anything that emits, cannot be branched on, and
leaves only through declassify — an effect of its own. That is
narrower than what CaMeL and TACIT do: they tag every value with its
provenance and permitted readers, and TACIT follows capabilities
through polymorphism, where Velaris marks two builtins' results and
refuses generic code over them unless a signature says so.
Until 5.0 its command line also granted every effect when no budget was
given, where a WASI module given nothing reaches nothing; from 5.0 a
run with no budget gets io alone.
The capability
format is published separately, under CC0, as
velaris-spec,
whose PRIOR_ART.md
sets out these differences and the older work in full. From 4.1 it
holds a conformance corpus an implementation in any language can run -
456 JSON cases at three levels, declaration, enforcement and the
ratchet, none needing a prover - written from this repository's suites
and held to them by a drift test; velaris conformance runs it against
this implementation, and CI does so on every leg.
Why Velaris
| Guarantee | What it means |
|---|---|
| Effects are visible | uses io, net, fs, ffi — a function without uses net can never touch the network, transitively, and one without uses ffi can never call out to Python. Hidden behavior does not compile. |
| Promises are proven | requires / ensures / loop invariant, verified by Z3 with modular call summaries — including records, maps, nested lists, quantified list properties, failure paths, and floats in genuine IEEE-754 (the prover refutes x + 0.1 + 0.1 == x + 0.2 with the exact double that breaks it). |
| Failure is unignorable | -> Int or fail in the signature; callers must check or try. Forgetting the error path is a compile error — builtins included. |
| Secrets cannot be printed, or looked at | Secret of T — what env() and read_file_secret() return. Nothing that emits or can fail will take one, a structure holding one carries it, every operation over one keeps it (a comparison included), and no if branches on one. declassify(value, "why") is the only way out: an effect of its own, with its reason named in the audit. SPEC.md §3.1 says what it still does not claim. |
| Fast where it's safe | Pure functions over numbers, list reads, and text — including text built inside them — JIT to native code via LLVM (~10,000× on hot arithmetic, ~45× on text building), differential-tested against the interpreter. Native reads are bounds-guarded and text is built in a runtime-owned buffer, so results always match interpreted. |
Why floats are proven in IEEE-754 rather than as real numbers, and what that costs: docs/floats.md.
Loops without written invariants are handled where the boring
invariants suffice: the compiler proposes bounds on each counter and
keeps the ones a loop step cannot break (see examples/inferred.vel).
Anything richer — membership, sortedness — still needs an invariant
line.
The prover never claims "proven without running" unless the counterexample is premise-complete — untranslatable assumptions abandon the proof to runtime checks rather than risk a false alarm. Soundness reports are treated as security issues.
Install
pip install velaris-lang
velaris doctor
velaris new hello && cd hello && velaris main.vel
Standalone executable (no Python required) — download for Windows / Linux / macOS from the latest release, then:
velaris doctor
With Python 3.10+:
pip install velaris-lang
velaris new hello && cd hello && velaris main.vel
Zero install — the playground runs the real compiler in your browser.
Optional extras for source installs: pip install ".[full]" adds
z3-solver (compile-time proofs) and llvmlite (native speed);
without them, promises are checked at runtime and everything runs
interpreted — same language, honestly degraded.
Everyday ergonomics
keep_if(xs, fn(n: Int) -> Bool { return n % 2 == 0 }) // inline functions
format("hi {}, {} left", name, count) // text with holes
args() // command line
post(url, body) / fetch_status(url) // not just GET
Function values are lifted to real functions, so proofs and native
compilation apply to them unchanged — and they can carry their own
requires / ensures, proven like any other function's. They can't capture surrounding
variables — the compiler tells you to pass them in instead.
Where it plugs in
velaris script.vel the command (io unless you say more)
import velaris a Python library
velaris mcp-install tools inside your assistant
velaris.mcpb double-click install for Claude Desktop
uses: gowrishankar-infra/velaris-lang a GitHub Action, findings in the Security tab
velaris capabilities check CI fails when the capability surface widens
velaris serve an HTTP door for any language, token required
npx velaris-lang script.vel npm, for the JavaScript world
%%velaris --audit --allow io a Jupyter cell
- repo: velaris-lang (pre-commit) a commit hook
docker run ... velaris check a container
velaris build --for-everyone standalone executables
Use it from your own program
import velaris
report = velaris.audit(source) # what it touches, what's proven
run = velaris.run(source, allow={"io"}) # it cannot touch anything else
print(run.output, run.refused_effect)
The budget is enforced the same way it is on the command line. There is
an MCP server too, so an assistant can write, audit and sandbox-run
Velaris without leaving the conversation — see
EMBEDDING.md and the versioned velaris.audit/1 format.
Calling run with a timeout or a memory cap starts a fresh interpreter
every time. A pool keeps workers alive under one fixed budget:
pool = velaris.Pool(size=4, allow={"io"}, timeout=30, max_memory_mb=512)
result = pool.run(source) # the same RunResult run() returns
pool.close()
200 sequential bounded runs of a small program: 46.6 s a process at a
time, 0.5 s on a pool. pool.run takes no allow — the budget belongs
to the pool, a worker is killed and replaced unless the run finished
cleanly, and a reused worker has every piece of mutable state reset
first. check_pool.py asserts each of those, including a program that
widens its own budget through ffi and cannot widen it for the next
one. The rules are stated in full in EMBEDDING.md.
A platform whose customers write the rules
examples/platform/ is that pattern as a small
FastAPI service, in one file. A customer submits Velaris source; the
service audits it, stores it with its capability surface, and answers
with what it declares — effects, hosts, paths, modules, the proven
share, its contracts function by function, and the narrowest budget that
would run it. It does not run it. A surface wider than the platform
permits is refused there, naming the grants that would have to be added.
Running happens on a velaris.Pool whose budget is the platform's.
Submit examples/discount.vel and the answer
says "proven_share": 100.0 with "status": "proven" on every promise,
including the two that matter to whoever is taking the payment: the
discount is never a surcharge, and what is left is never negative. That
is the sentence a platform can show a customer before offering to enable
a rule, and it is not one a sandbox can produce.
Written by a model, audited by you, run in a box
velaris card > card.md # ~3,700 words: paste into any model
velaris audit script.vel # what it can touch, before you run it
velaris attest script.vel --output script.intoto.json # the same, bound to its bytes
velaris script.vel # io, and nothing else, unless you say more
velaris audit is written for the reviewer: what the program reaches,
what it promises, how much of that is proven rather than checked
while running, what can fail, and the exact command to run it safely.
velaris attest (4.2) puts that audit in an in-toto Statement whose
subjects are the program's files by sha256, ready to sign with cosign
or sigstore-python; EMBEDDING.md shows both, and every
release carries one, signed, for an example program.
agent_loop.py closes the circle — a model writes it, velaris check --json hands back errors with fixes, and it iterates until the program
compiles and its promises prove.
Running code you did not write
velaris agent_output.vel # io: it may print, nothing else
velaris agent_output.vel --allow io,fs:read:./data # and read that folder
velaris agent_output.vel --allow all --deny net,ffi # everything but these
The runtime refuses any effect outside the budget you grant, whatever
the source claims — and a refusal cannot be caught and carried past.
Not a security boundary (ffi grants everything Python can do), but a
real guard for running a program you have not read.
Checking everything at once
velaris examples/stress.vel --allow clock,env,ffi:datetime,math,sqlite3,io,net:raw.githubusercontent.com
# 33 checks across the whole language
velaris examples/edges.vel --allow ffi:datetime,io
# 20 boundary, property and round-trip checks
python check_refusals.py # 25 wrong programs, each refused correctly
python check_sandbox.py # 39 escape attempts, each refused with its code
python check_secret.py # a Secret reaches nothing that emits it
python check_pool.py # a pool must leak nothing between programs
python check_platform.py # the reference platform refuses what it says it does
python check_ratchet.py # every widening fails, nothing else does
velaris conformance # velaris-spec's 456-case corpus, L1 to L3
One command that exercises the language, the standard library, the prover, native compilation, JSON, dates, CSV, the host language and the network.
Measured against other tools
67 small programs — 59 with one deliberate defect, 8 correct controls — each written three times with the same behaviour, in Velaris, in JavaScript for Deno, and in Python. One harness runs every program through every tool and records what was caught before running, what was caught while running, and what was missed. The twelfth category (7.1) is indirect authority: the calling code is the same before and after, and only a dependency's declared budget widened between two versions.
| caught before running | caught while running | missed | false positives on the 8 controls | |
|---|---|---|---|---|
| Velaris 7.1 | 45 | 12 | 2 | 0 |
| Deno 2.9 | 5 | 30 | 24 | 0 |
| Python 3.13 | 0 | 28 | 31 | 0 |
The two Velaris misses are in the table by design: a loop that stops
one item early with no contract to contradict, and a program that
prints rm -rf build for its caller and touches nothing. Both are
named, with the reason each is not catchable, in
benchmark/RESULTS.md — regenerated by one
command, python benchmark/run.py, which also lists the rows the
prover settles only while running.
Two real programs
examples/ledger.vel — an expense tracker: records, integer cents,
file persistence, sorted reports.
examples/wordcount.vel — text analysis:
velaris examples/wordcount.vel --allow fs:read,io <file> [n] counts
word frequencies and prints a ranked histogram.
examples/linkcheck.vel — a link checker you would actually run:
velaris examples/linkcheck.vel --allow io,net <url> ..., non-zero exit
when something is broken.
examples/fetcher.vel — an HTTP tool: checks a status, then summarises
a page, with every network call declared and every failure handled.
JSON
json_get(doc, "user.name") json_int(doc, "user.age")
json_len(doc, "tags") json_of(Person(name: "gowri", age: 30))
Paths walk objects and lists, every read can fail (a missing field is a possibility, not a crash), and none of it is an effect — parsing text is pure.
Reaching other languages
fn today() -> Text uses ffi or fail {
let nothing: List of Text = []
return try py("datetime.date", "today", nothing)
}
py / py_int / py_float / py_json call Python functions, and
py_new / py_do / py_field / py_close hold real objects — a
database connection, a session — so every library Python has is
reachable — but only from a function that declares uses ffi, and it
can fail like anything else that leaves your program.
The standard library reaches outside
import "http.vel" as http import "db.vel" as db
import "time.vel" as time import "env_tools.vel" as sys
check http.get(url) { ok body { ... } fail why { ... } }
check db.count(conn, "notes") { ok n { ... } fail why { ... } }
Written in Velaris, so they carry their effects — a program using
http shows net, one using db shows ffi, and a pure function
can call neither.
Libraries
velaris add https://example.com/geo.vel as geo # vendored into lib/
velaris deps # what you depend on
velaris deps --verify # unchanged since?
A library is compiled before it is accepted and kept in your repository where you can read it. No registry, no resolver, nothing fetched at build time.
velaris add writes velaris.lock beside velaris.toml: every
vendored library with its source, the sha256 of the exact bytes that
arrived, and the version of Velaris that added it. velaris deps --verify fails if a file's hash differs from the lock or a locked
library is not on disk — a line worth having in CI. Adding a library
that is already vendored, with different bytes, is refused with both
digests printed; --force replaces it.
Imports
import "lib/geo.vel" as geo // named: geo.distance(a, b)
import "std.vel" // flat: sort(xs)
A named import prefixes that library's functions, so two libraries that
both export distance can be used in the same file.
Shipping a program
velaris build myprogram.vel # one executable, ~90 MB
./myprogram alpha beta # runs anywhere, nothing installed;
# it takes --allow like the compiler
velaris build myprogram.vel --for-everyone # a workflow that builds
# Windows, Linux and macOS
Your program, its imports, the standard library and the compiler, in one file. It is compiled and proof-checked before it is built.
Tooling
velaris trace program.vel (watch every call as it happens) ·
velaris test program.vel (runs every test_* function written in
Velaris) ·
velaris check program.vel (compile without running; several files at
once, --json for tools) ·
velaris explain program.vel (a walkthrough of every function: effects,
promises, and whether they are proven — explain <folder> maps a whole
project) ·
velaris repl (definitions are proof-checked as you type them) ·
velaris fmt (canonical style, --check for CI) · velaris lsp
(errors as you type in any LSP editor; a VS Code extension lives in
editor/vscode) ·
velaris doctor · velaris new · --json errors for automation.
Standard library
Written in Velaris, in stdlib/std.vel — and it
keeps its own promises: sort carries ensures is_sorted(result),
max_of requires a nonempty list, and violating a library requires
is a compile error at your call site. Full
reference,
generated from the real compiler.
Numbers
Whole numbers are 64-bit. Arithmetic that outgrows that range is an error, not a silent wrap — and the same error whether your code is interpreted or running as machine code. Floats are IEEE-754 doubles, proven as such.
Money is neither. money(1250, "INR") is 12.50 rupees held as 1250
paise: an exact whole number of minor units, with the currency in its
type, so INR meeting USD is a compile error and no Float goes near it.
Dividing an amount says how it rounds — percent_of(claim, 25, 1000, "half_up") — or it does not compile, and money.split(payout, 3)
gives parts that provably add up to the payout. See
examples/settlement.vel and
SPEC.md §4.3.
Remembered proofs
A second velaris check of an unchanged program does not run the prover
again: what it proved is remembered in a directory that belongs to you,
not to the program - %LOCALAPPDATA%\velaris\proofs on Windows,
$XDG_CACHE_HOME/velaris/proofs (or ~/.cache/velaris/proofs)
elsewhere. A program's entries are keyed by its absolute path, a SHA-256
of its exact bytes and the compiler's version, and checked against all
three when they are read, so an edited file, the same file at another
path, a hand-edited entry or a new Velaris is proved again rather than
believed. Within that, a proof is keyed by the function's text and the
contracts it depends on, so changing a promise re-proves everything that
relied on it.
A ./.velaris/ directory is never read. Until 7.1.2 the cache lived
there, beside the program, and one shipped with an untrusted program
could make a false promise report "proven"
(advisory-proof-cache.md); velaris audit
prints ignored: ./.velaris/ when it finds one. If no per-user directory
can be written, the run goes ahead with no cache. The library and the
worker pool never use it.
--no-cache neither reads nor writes the cache: every promise is proved
from scratch. velaris clean deletes the per-user velaris cache
directory; when the current directory holds an old ./.velaris/, it says
that directory is ignored and leaves deleting it to you.
The reference
SPEC.md states precisely what the language means: semantics, evaluation order, effect propagation, what "proven" covers today, and what Velaris deliberately does not have — including why it has no concurrency model.
Stability
Semantic versioning: breaking changes only at major versions.
STABILITY.md says what that covers - the language, the
error codes, velaris.audit/1, the library API, the budget grammar and
the command line - what it does not, the rules for deprecating and
removing, and every time this project has broken the rule, 3.3 and 3.4
among them. CI tests every push on Linux, Windows and macOS, Python
3.10 and 3.12, with and without the optional dependencies. Errors are
stable, numbered, and
fully documented.
How much is proven
velaris proofs . # 35 of 58 promise-carrying functions proven (60%)
velaris proofs . --min 80 # fails the build below 80%
Using Velaris in CI
The GitHub Action audits the Velaris programs in a repository - its
.vel files - and reports what they may touch to GitHub code scanning.
It does not read Python, JavaScript, Go or anything else: a repository
with no .vel file prints no .vel files found and the job is green.
The case it serves is narrow, and it is the one this language exists
for - an agent wrote a script, the script is in Velaris, and the
effects it declared and the promises it did not prove should land in
the Security tab rather than in a reviewer's head.
Copy this into .github/workflows/velaris.yml:
name: velaris
on: [push, pull_request]
permissions:
contents: read
security-events: write # so the findings reach code scanning
jobs:
velaris:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- uses: gowrishankar-infra/velaris-lang@v8.0.0
That is the whole workflow. With no with: block the Action installs
Velaris and the prover, checks every .vel file in the repository,
fails the job if one does not compile or carries a promise the prover
refutes, and uploads its findings as SARIF 2.1.0 with
github/codeql-action/upload-sarif, pinned to a commit. A private
repository needs code scanning enabled; set sarif: "false" if it has
neither that nor security-events: write. On a pull request from a
fork the job's token cannot upload, so that step is skipped - the file
is still written, and its path is the sarif-file output. The findings
print to the job log either way.
What appears in the Security tab
One alert per finding, on the line that caused it, with a link to its row on the errors page. These are the rule IDs, and a real message from each:
| rule | level | what an alert says |
|---|---|---|
E300 |
error | function 'fetch' calls 'read_file' which needs effect 'fs', but 'fetch' declares no effects (it is pure) |
E520 |
error | 'to_int' can fail - that cannot be ignored |
E700 |
error | promise cannot be kept: 'discount' ensures result >= 0 - proven without running the program: price = 9 gives result = -1 |
E701 |
error | this call can break a promise: 'discount' requires price >= 0, but 'main' can call it with price = -3 - proven without running the program |
unproven-promise |
warning | 'count_rows': ensures result >= 0 - not proven before running; checked while the program runs |
contract-coverage |
note | 'total' takes or returns data and promises nothing about it |
capability-widened |
error | net is needed by sync.vel, not in the surface of velaris.capabilities (a new effect, net) |
capability-effect-gained |
error | 'main' now declares net, which it did not in velaris.capabilities: net: calls pull at line 6, which declares net |
capability-narrowed |
note | surface: "net" is no longer needed - the baseline gives more than the code needs; capabilities init --force records the narrower surface |
dependency-capability-widened |
error | npm:mixed 0.1.0 -> 0.2.0: net:telemetry.example.net is needed by lib/report.vel (a new effect, net) |
dependency-effect-gained |
error | npm:mixed 0.1.0 -> 0.2.0: 'render' now declares net: net: calls post at line 3 |
dependency-install-script |
error | npm:textkit 1.0.0 -> 1.1.0: an install-time script was added: npm postinstall: node setup.js [registry manifest, tarball package.json]; what it does is not derived |
dependency-surface-unknown |
note | npm:textkit 1.0.0 -> 1.1.0: capability surface unknown. Neither 1.0.0 nor 1.1.0 holds a .vel file, so there is no declared capability surface to compare. ... |
dependency-added |
note | npm:textkit 1.0.0 -> 1.1.0: now declares helper ^2.0.0 (dependencies); its own surface was not examined |
dependency-narrowed |
note | velaris.lock:mailer 6ed598a1e2bf -> 3f7a9875d0de: surface: "net:collector.example.net" is no longer needed |
Every code in the compiler's error table is a rule of its own, so a
parse error (E1xx), an unknown function (E200) or a type error
(E5xx) arrives the same way; E3xx are the effect codes and E7xx
the prover's. Under check --strict an unproven promise is an error
rather than a warning, and a loop not shown to end is E612. The
uses-io, uses-fs and loop-not-shown-to-end notes come from
velaris audit --sarif, which the Action does not run; pr-comment
below is where the Action reports those. The dependency-* rows come
from deps-diff, below, and only when that input is on; each lands on
the line of the lockfile that pins the upgraded version.
Velaris's suggested fixes are sentences, while a SARIF fix must hold
the exact bytes to change, so they travel in each result's
properties.fixes rather than as SARIF fixes with an edit made up to
fill the slot.
The budget a repository declares
velaris capabilities init records the capability surface a
repository's .vel files need - effects, paths, hosts, Python modules,
how many file and network operations a run can perform, and each
function's effects - in velaris.capabilities; commit it. From then on
the Action runs velaris capabilities check on every push and fails
any change that needs more, naming what widened, the file, function and
line that introduced it, and the edit to the baseline that would accept
it. Those are the capability-* rows above, and they go to code
scanning beside the check's.
The comparison is always with that file, never with the previous
commit: capability added across many small commits, none alarming by
itself, fails at every one of them until someone widens the file, where
the change shows in review. A pull request that deletes
velaris.capabilities fails too, since that would turn the ratchet
off; capabilities: "off" in the workflow is the way to turn it off,
where the change is visible. Without the file the ratchet is simply
off. EMBEDDING.md has the rules; check_ratchet.py
holds them, including a six-commit history that fails only at the
commit that reaches the network.
What an upgrade gained
A dependency can change what it can do between two versions while its name, its publisher and its list of dependencies stay the same. The npm package postmark-mcp is a documented case: Koi Security reported in September 2025 that versions 1.0.0 to 1.0.15 worked as an email tool, and that 1.0.16 added a blind copy of every outgoing message to an outside address. A signature from the same publisher verifies both versions; an SBOM lists the same dependencies for both.
velaris deps-diff compares two versions of one dependency:
velaris deps-diff dir:vendor/mailer 1.4.0 1.5.0 # a directory per version
velaris deps-diff git:https://github.com/o/mailer v1.4.0 v1.5.0
velaris deps-diff npm:some-package 1.0.15 1.0.16
velaris deps-diff pypi:some-package 2.31.0 2.32.0 --json
velaris deps-diff --against origin/main # every upgrade in the changed lockfiles
For a Velaris library it computes each version's capability surface
from its .vel files, as capabilities init would, holds the newer
one to the older one as capabilities check holds a tree to its
baseline, and reports what the newer one gained - effects, hosts,
paths, Python modules, operation counts, and functions that declare an
effect they did not - with the file, line and call of each:
GAINED net:collector.example.net - not in 1.4.0's surface
in mailer.vel
mailer.vel:3 send calls post("https://collector.example.net/copy")
GAINED net operations in mailer.vel: at most 2 in a run; 1.4.0 had at most 1
A caller that already declared net for its own request compiles
against both versions, so the compiler has nothing to refuse; the
difference is in what the dependency declares, and that is what this
reads. The benchmark's category 12 is three programs of that shape and
one control.
For any other package it reads what the registry and the package's
archive declare, and nothing more: the install-time scripts npm or pip
runs (preinstall, install, postinstall, npm's node-gyp rebuild,
setup.py, the build backend, a .pth file that imports) and whether
each was added or changed - including a changed file behind an
unchanged command, and, when a registry's manifest and the tarball's
package.json disagree, the scripts of both, since which one npm runs
has changed between npm versions - and the declared dependencies. It
does not derive what Python or JavaScript code can do, and does not
guess: it reports the capability surface as unknown, and exits 3
rather than 0. That
answer is often all there is. By Koi Security's account 1.0.16 of
postmark-mcp changed nothing but the code that added the copy, so
deps-diff would have found no install script and no dependency to
report, and would have said the surface is unknown. (npm has since
unpublished every version of that package; today deps-diff reports
that neither version can be read.)
Exit codes: 0 when both surfaces were derived and nothing was gained; 1
when something was gained; 3 when nothing visible was gained and the
surface was not derived; 2 when a version could not be read. --json
is velaris.deps-diff/1; --sarif writes the dependency-* results
above. A package argument names where to read it - pypi:, npm:,
git: or dir: - and a bare name is refused, so an npm package is
never compared with a PyPI package of the same name.
VELARIS_NPM_REGISTRY and VELARIS_PYPI_URL point it at a mirror.
With deps-diff: "true", on a pull request the Action runs
velaris deps-diff --against the base: it reads the lockfiles the pull
request changed - package-lock.json, npm-shrinkwrap.json,
requirements*.txt pins, Pipfile.lock, poetry.lock, uv.lock,
pdm.lock and velaris.lock, whose vendored libraries it compares
file against file - compares every upgraded dependency, up to 30, and
posts one comment saying what each gained, editing that comment on
later runs rather than adding another. A lockfile it does not read
(yarn.lock, pnpm-lock.yaml, and others) is named in the comment as
changed and not read. An entry resolved from git, a path, or a registry
or index other than the one it reads is left out and said, because the
public package of the same name would be a different package; so is
every pin of a requirements*.txt that sets another index. The
findings go to code scanning when sarif is on. It needs
pull-requests: write, and it never fails the job.
Everything else the Action takes
- uses: gowrishankar-infra/velaris-lang@v8.0.0
with:
files: "src/*.vel" # default: every .vel file in the repository
version: "8.0.0" # default: the Action's own tag (8.0.0)
proofs: "true" # the default; installs z3-solver
format: "true" # also fail if the code is not canonically formatted
min-proven: "80" # fail below this percent of promises proven
pr-comment: "true" # audit every changed .vel on the pull request
sarif: "true" # the default; findings to code scanning
capabilities: "check" # the default once velaris.capabilities exists
deps-diff: "true" # comment on what each upgraded dependency gained
With pr-comment: "true" on a pull_request event the Action posts one
comment holding the velaris audit of every .vel file the pull
request changes - effects and Python modules reached, proven share, the
safe command, and warnings such as a loop not shown to end - and edits
that same comment on later runs instead of adding another. The comment
also carries the ratchet's result and a velaris review of the branch
against its base: surface, proven share, new fallible functions, new
hosts and paths, and a one-word risk computed from those facts alone.
It uses the REST API with the job's own GITHUB_TOKEN, so the job needs
permissions: pull-requests: write. The audit is posted whether or not
the checks passed; a file that does not compile is reported as such.
The same SARIF without the Action, for SonarQube
(sonar.sarifReportPaths), Azure DevOps or anything else that reads it:
velaris check src/*.vel --sarif > velaris.sarif # exit 1 as the plain check
velaris proofs src --sarif > proofs.sarif # promises left to runtime
velaris audit src --sarif > audit.sarif # what each function may touch
velaris capabilities check --sarif > caps.sarif # what widened past the baseline
One run, driver Velaris with its version, and a rule for every code in
the error table plus the findings that are not errors. Each result has
the file, the line and Velaris's message.
Or without installing anything:
docker run --rm -v "$PWD:/work" velaris check /work/main.vel
What a reviewer should read before allowing agent-written Velaris to run: THREAT_MODEL.md, COMPLIANCE.md and the verification steps in SECURITY.md.
Project
Roadmap · Support and expectations · How the compiler works · Maintainers · Security policy · Stability · Changelog
Maintained by one person, in the open, with the limits stated plainly in SUPPORT.md.
Cite this repository
The author is Palakurthi Gowri Shankar (family name Palakurthi). CITATION.cff holds the citation, and GitHub offers it as "Cite this repository" beside the file list. A preprint describing Velaris is forthcoming; until it is published, cite the repository. The capability format is cited separately, from velaris-spec's own CITATION.cff. PROVENANCE.md records the dates and the archive identifiers.
Contributing
The entire implementation is one readable file, velaris.py, in
pipeline order — lexer to LSP. Start with
ARCHITECTURE.md for how it fits together, and
MAINTAINERS.md for what review looks like.
Looking for somewhere to start? See the good first issues — small, self-contained tasks, each with the file to open and what "done" means.
The example programs in examples/ each carry an expected
verdict, and about half are designed to be rejected — each rejection
demonstrates a guarantee. Before any change ships:
python run_tests.py # every example, expected verdicts
velaris test examples/std_test.vel # the library's own tests
python fuzz_native.py 60 # both engines must agree
velaris fmt examples/*.vel stdlib/*.vel --check
License
MIT © Palakurthi Gowri Shankar
Metadata
Release files for velaris-lang 8.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| velaris_lang-8.0.0.tar.gz | 64.6 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| velaris_lang-8.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 64.9 MB
Release files / velaris_lang-8.0.0.tar.gz
| Download URL | velaris_lang-8.0.0.tar.gz |
|---|---|
| Size | 64.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e3b1dcae7c36d552324f4e9a194468e33207d60efd9e4e618ed7070e26f3d5d6
|
|
BLAKE2b-256 checksum How to use checksums |
85edff34f2cbcbaa9f886525bc4447013df23f51a8fa00f5c6d17ca44e7843d5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 13, 2026.
Transparency logRelease files / velaris_lang-8.0.0-py3-none-any.whl
| Download URL | velaris_lang-8.0.0-py3-none-any.whl |
|---|---|
| Size | 256.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
44a7e3e109387e8d84fbd9b7d5decdd859bea035152a7b479d5eeba2a1c84972
|
|
BLAKE2b-256 checksum How to use checksums |
d5ba3e5db7b52c9c4f322718b6bf356802a5494a1f7544ecee48954cf56b5a48
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 13, 2026.
Transparency log