Manage your Renku projects, datasets, and jobs from the terminal.
curl -sfSL https://raw.githubusercontent.com/SwissDataScienceCenter/renku-cli/main/install.sh | bashnix profile install github:SwissDataScienceCenter/renku-cliFor other installation methods (manual binary, NixOS integration), see the Installation Guide.
The CLI can generate completions for bash, fish, zsh, and PowerShell. These can make it much easier to use the CLI and pick entities to work with. Add the following to your shell configuration:
# Bash
echo "source <(COMPLETE=bash rnk)" >> ~/.bashrc
# Fish
echo "COMPLETE=fish rnk | source" >> ~/.config/fish/config.fish
# Zsh
echo "source <(COMPLETE=zsh rnk)" >> ~/.zshrc
# PowerShell
echo '$env:COMPLETE = "powershell"; rnk | Out-String | Invoke-Expression; Remove-Item Env:\COMPLETE' >> $PROFILEGet up and running in three steps:
# 1. Authenticate to your Renku instance
rnk login
# 2. Clone a project
rnk clone <project-ref>
# 3. List running jobs
rnk job list| Command | Description |
|---|---|
rnk login |
Perform interactive login to Renku |
rnk logout |
Remove stored credentials |
| Command | Description |
|---|---|
rnk clone <project-ref> |
Clone a project by ID, namespace/slug, or URL |
rnk project clone <project-ref> |
Same as above (full command form) |
rnk project activate <project-ref> |
Set the active project for the current user (short form: rnk p a) |
rnk project deactivate |
Unset the active project (short form: rnk p d) |
rnk project current |
Show the currently active project (short form: rnk p c) |
rnk project list |
List projects (supports --all / -a to show all projects, --n-results / -n to limit results) |
| Command | Description |
|---|---|
rnk dataset deposit |
Manage dataset deposits |
| Command | Description |
|---|---|
rnk job list |
List jobs |
rnk job start |
Start a job |
rnk job stop |
Stop a job |
rnk job logs |
View job logs |
| Command | Description |
|---|---|
rnk session start --launcher <id> |
Start an interactive session using a launcher |
rnk session stop <session-id> |
Stop a running session |
rnk session list |
List currently running sessions |
rnk session logs <session-id> |
View session logs |
| Command | Description |
|---|---|
rnk launcher list |
List currently running launchers |
| Command | Description |
|---|---|
rnk version |
Show client and server version info |
rnk update |
Check for and install updates |
All commands share these environment variables:
| Variable | Description |
|---|---|
RENKU_CLI_RENKU_URL |
Base URL to your Renku instance |
RENKU_CLI_PROJECT_CONTEXT |
Default project context (<username>/<project> or project ID) |
RENKU_CLI_ACCESS_TOKEN |
Manual access token (skips rnk login if set) |
The effective project context is resolved in this precedence order:
--project-contextCLI flagRENKU_CLI_PROJECT_CONTEXTenvironment variable.renku/config.tomlin the current directory (written byrnk clone)- Global active project set with
rnk project activate(stored in~/.config/renku-cli/active_project.toml)
Global flags available on every command:
--format json— structured JSON output instead of human-readable--proxy <url>/--proxy none— control proxy usage-v/-q— increase / decrease log verbosity
For a full list of options, run rnk --help.
Full documentation is available in the docs/ directory.