The yasumu info command displays detailed information about a Yasumu workspace, including metadata, statistics, REST entities, and environments.
Usage
Options
Path to the workspace directory. Defaults to the current directory.
Output the workspace information as JSON instead of formatted text.
Examples
Display information about the workspace in the current directory:
Output:
┌─ Yasumu Workspace
│
├─ Name: My API Project
├─ ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890
├─ Version: 1.0.0
├─ Path: /home/user/projects/my-api/yasumu
├─ Snapshot: 2024-03-15T10:30:00.000Z
│
├─ Statistics
│ ├─ REST Entities: 15
│ ├─ Environments: 3
│ └─ Groups: 4
│
├─ REST Entities
│ ├─ GET Login API [script]
│ │ https://api.example.com/auth/login
│ ├─ POST Create User [script, test]
│ │ https://api.example.com/users
│ └─ GET List Users
│ https://api.example.com/users
│
├─ Environments
│ ├─ Development (5 vars, 2 secrets)
│ ├─ Staging (7 vars, 3 secrets)
│ └─ Production (8 vars, 4 secrets)
│
└─────────────────────────
Specify workspace path
View information for a workspace in a specific directory:
yasumu info --path /path/to/workspace
JSON output
Get workspace information as JSON for parsing or integration:
Output:
{
"workspace": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "My API Project",
"version": "1.0.0",
"path": "/home/user/projects/my-api/yasumu",
"snapshot": 1710499800000
},
"stats": {
"restEntities": 15,
"environments": 3,
"groups": 4
},
"restEntities": [
{
"id": "entity-123",
"name": "Login API",
"method": "GET",
"url": "https://api.example.com/auth/login",
"hasScript": true,
"hasTest": false
},
{
"id": "entity-456",
"name": "Create User",
"method": "POST",
"url": "https://api.example.com/users",
"hasScript": true,
"hasTest": true
}
],
"environments": [
{
"id": "env-001",
"name": "Development",
"variableCount": 5,
"secretCount": 2
},
{
"id": "env-002",
"name": "Staging",
"variableCount": 7,
"secretCount": 3
}
]
}
Text output
The default text output includes:
- Workspace metadata: Name, ID, version, path, and last snapshot timestamp
- Statistics: Count of REST entities, environments, and groups
- REST entities: List of all entities with method, name, URL, and flags indicating scripts/tests
- Environments: List of all environments with variable and secret counts
HTTP methods are color-coded:
- GET: Green
- POST: Yellow
- PUT: Blue
- PATCH: Cyan
- DELETE: Red
JSON output
The JSON output provides structured data suitable for:
- CI/CD pipeline integration
- Automated reporting
- Workspace analysis tools
- Custom scripting and automation
Error handling
If no workspace is found at the specified path:
yasumu info --path /invalid/path
No Yasumu workspace found at: /invalid/path/yasumu