The istok project command group lets you inspect and manage projects registered with Istok.
Most commands operate on the project associated with the current repository. Commands that accept a project selector can also target another registered project explicitly.
Commands
istok project --help
The available project commands are:
| Command | Purpose |
|---|---|
show [SELECTOR] |
Show a project. |
list |
List registered projects. |
rename NAME |
Rename a project. |
rebind SELECTOR [PATH] |
Associate a project with a different repository path. |
delete |
Remove a project from the active project list. |
restore SELECTOR [PATH] |
Restore a previously deleted project. |
Project selectors
Commands that accept SELECTOR can identify a project by:
- its ID;
- an unambiguous ID prefix;
- its name.
For example:
istok project show my-project
or:
istok project show 01a00b35
When a command supports the current project and no selector is provided, Istok resolves the project from the current working directory.
Show the current project
Run:
istok project show
to inspect the Istok project associated with the current repository.
You can also inspect another project explicitly:
istok project show my-project
This is useful when you want to check project identity, state, or repository binding.
List projects
List active local projects:
istok project list
The human-readable output shows the project name, state, and repository root.
Use this command when you want to see which repositories are currently registered with Istok.
Rename a project
Rename the current project:
istok project rename new-name
To target another project explicitly:
istok project rename new-name --project my-project
Renaming changes the Istok project name without changing the repository directory or project state.
Rebind a project
If a repository moves to another location, rebind the existing Istok project instead of initializing a new one.
istok project rebind my-project /path/to/repository
If the path is omitted, the current directory is used:
cd /path/to/repository
istok project rebind my-project
Rebinding preserves the existing Istok project state while changing the repository root associated with it.
This is useful after moving or renaming a local repository directory.
Delete a project
Delete the current project from the active project list:
istok project delete
Istok asks for confirmation before performing the operation.
To skip the confirmation:
istok project delete --yes
You can target another project with:
istok project delete --project my-project
Deleting an Istok project does not delete the repository or its files.
The project is kept in a recoverable state so it can be restored later. Its repository path is released and can be associated with another Istok project.
When using JSON output, --yes is required so the command does not wait for interactive confirmation.
Restore a project
Restore a previously deleted project:
istok project restore my-project
When possible, Istok reuses the repository root previously associated with the project.
You can also provide a path explicitly:
istok project restore my-project /path/to/repository
This is useful when the repository has moved since the project was deleted.
Restoring brings the existing Istok project state back into active use.
Moving a repository
If you move an initialized repository, use rebind rather than creating another Istok project.
For example:
mv ~/work/my-project ~/projects/my-project
cd ~/projects/my-project
istok project rebind my-project
The same tasks, context, runs, and other project state remain associated with the project.
Inspect command help
Every subcommand provides its own help:
istok project show --help
istok project rebind --help
istok project restore --help
Use these commands to inspect the exact arguments and flags available for the installed version of Istok.
Next
Continue with the task command reference to learn how to inspect and manage tasks directly from the CLI.