Skip to content

Get Ingredient Info

The vdc ingredient get command retrieves comprehensive information about ingredients, including metadata, configuration, and release statistics. This command is essential for discovering ingredients, validating their properties, and gathering information for automation workflows.

Command syntax

vdc ingredient get [options]

Required Parameters

You must specify either:

  • Project, feed, and name combination OR
  • Ingredient ID

Options Reference

Option Shortcut Description Required Example
--project <project> -p The project name in VDC Yes* --project validation-team
--feed <feed> -f The feed name Yes* --feed main
--name <name> -n The ingredient name Yes* --name IFWI_NVL
--id <id> -i The ingredient identifier Yes* --id ING-123456
--format <json\|yaml> Output format No --format yaml
--verbose Enable detailed logging No --verbose
--token <token> Authentication token Yes --token $VDC_TOKEN

Info

Either --project/--feed/--name combination OR --id is required

Usage Examples

Get Ingredient by Project/Feed/Name

# Basic ingredient information
vdc ingredient get -p validation-team -f main -n IFWI_NVL --token $VDC_TOKEN

# Human-readable YAML output
vdc ingredient get -p validation-team -f main -n BIOS_DMR --format yaml --token $VDC_TOKEN

# With verbose logging for debugging
vdc ingredient get -p myproject -f experimental -n custom-firmware --verbose --token $VDC_TOKEN

# Using long form parameters
vdc ingredient get --project validation-team --feed main --name IFWI_NVL --token $VDC_TOKEN

Get Ingredient by ID

# Using ingredient ID (when known)
vdc ingredient get --id 123456 --token $VDC_TOKEN

# ID with YAML output
vdc ingredient get -i 789012 --format yaml --token $VDC_TOKEN

Output formats

JSON Output (Default)

{
  "Description": null,
  "FeedName": "Default",
  "IngredientFamily": "Firmware",
  "IngredientType": "IFWI",
  "Name": "TTK_PTL_IFWI_Integration",
  "ProjectName": "VDC-DEV-Sandbox",
  "ReadableId": 1002,
  "SchemaType": "Ifwi",
  "Silicon": "PTL",
  "Sku": null,
  "Segment": "PTL-P",
  "Step": null,
  "Milestones": [],
  "HasPackages": true,
  "HasDependencies": true,
  "ValidationDiscipline": null,
  "IsOfficial": false,
  "ReleaseCount": 2,
  "CreatedBy": {
    "Email": "roni.dayan@intel.com",
    "DisplayName": "Dayan, Roni"
  },
  "CreatedAt": "2025-07-22T11:51:03.1098803Z",
  "UpdatedBy": {
    "Email": "N/A",
    "DisplayName": "AutoGenerated"
  },
  "UpdatedAt": "2025-07-23T14:51:20.9456536Z"
}

YAML Output (Human-Readable)

Description:
FeedName: Default
IngredientFamily: Firmware
IngredientType: IFWI
Name: TTK_PTL_IFWI_Integration
ProjectName: VDC-DEV-Sandbox
ReadableId: 1002
SchemaType: Ifwi
Silicon: PTL
Sku:
Segment: PTL-P
Step:
Milestones: []
HasPackages: true
HasDependencies: true
ValidationDiscipline:
IsOfficial: false
ReleaseCount: 2
CreatedBy:
  Email: roni.dayan@intel.com
  DisplayName: Dayan, Roni
CreatedAt: 2025-07-22T11:51:03.1098803Z
UpdatedBy:
  Email: N/A
  DisplayName: AutoGenerated
UpdatedAt: 2025-07-23T14:51:20.9456536Z

Understanding Output Fields

Core Identity

  • ReadableId: Unique system-generated ingredient identifier
  • Name: User-provided ingredient name
  • IngredientType: Ingredient type (e.g., IFWI, BIOS, UCODE)
  • IngredientFamily: Ingredient family (e.g., Firmware, Software)
  • ProjectName/FeedName: Location in VDC hierarchy

Silicon Information

  • Silicon: Silicon family (e.g., PTL, NVL, DMR)
  • Segment: Silicon segment (e.g., PTL-P, CLIENT, SERVER)
  • Step: Silicon step (e.g., A0, B0)
  • Sku: Silicon SKU information
  • Milestones: Associated silicon milestones

Release Information

  • HasDependencies: Whether ingredient supports dependencies
  • HasPackages: Whether releases include package files
  • ReleaseCount: Number of published releases

Business Properties

  • Description: User-provided ingredient description
  • IsOfficial: Whether ingredient is marked as official
  • ValidationDiscipline: Associated validation group (FV, PIV, etc.)

Audit Information

  • CreatedBy/CreatedAt: Original creator and creation time
  • UpdatedBy/UpdatedAt: Last modifier and modification time

Error handling

Common Error Scenarios

Ingredient Not Found

# Command returns non-zero exit code
vdc ingredient get --project invalid-project --feed main --name nonexistent --token $VDC_TOKEN
# Exit code: 1 (not found)

Invalid Parameters

# Missing required parameters
vdc ingredient get --project myproject --token $VDC_TOKEN
# Error: Either --name and --feed, or --id is required

Next Steps

Learn More About Ingredients

Work with Releases

Integration and Automation