Projects
Commands for listing, creating, renaming, and selecting projects. The project ID is the unit of isolation for events and keys. Most other commands need one (either explicitly via --project <id> or implicitly via the saved default).
Commands
| Command | What it does |
|---|---|
es projects list |
List your projects. |
es projects get <id> |
Show one project. |
es projects create --name <name> |
Create a project. |
es projects update <id> --name <new-name> |
Rename a project. |
es projects delete <id> |
Soft-delete (server-side). |
es projects use <id> |
Set the current project context. |
es projects current |
Print the saved default project ID. |
es projects describe [id] |
Show a project plus everyone with access (members and roles). |
es projects share <email> --role <role> |
Share the project with a collaborator. |
es projects unshare <email> |
Revoke a collaborator's access to the project. |
Default project
Running es projects use <id> persists the ID to ~/.config/everscribe/config.json so subsequent es keys and es events commands can omit --project. The config file is split from the PAT file (pat.json) on purpose. es auth logout doesn't clobber your saved default.
If you work across multiple projects regularly, skip es projects use and pass --project <id> explicitly each time.
Sharing projects
Give other people access to a project by sharing it with one of your collaborators. They must already be an active collaborator first (see Collaborators). Sharing is strict and won't invite someone implicitly.
# 1. add them to your collaborator list (once)
es collaborators add [email protected]
# 2. grant access to the current project (or pass --project <id>)
es projects share [email protected] --role editor
# see who's on a project
es projects describe
# revoke access
es projects unshare [email protected]
Roles are per-project:
| Role | Can |
|---|---|
viewer |
Read the project's events and activity (read-only). |
editor |
Everything a viewer can, plus run instrumentation scans and set retention. |
admin |
Full access. Manage API keys, integrations, sharing, and project settings. |
es projects share, unshare, and describe all default to the project saved by es projects use; pass --project <id> to target another.