Overview
Overview
The Reference section provides essential documentation for developers and users who need quick access to technical information, command-line tools, definitions, and solutions to common problems.
📚 Quick Access
The Reference section includes:
CLI Reference - Command-line tool documentation
Glossary - Key terms and definitions
FAQs - Common questions answered
Troubleshooting - Problem diagnosis and solutions
What's in Reference
Complete command-line interface documentation for Test Orchestration platform.
Includes:
Command syntax and options
Common workflows via CLI
Environment variables
Configuration files
Examples and use cases
Use when: You need to automate workflows, integrate with CI/CD, or work from command line.
Comprehensive definitions of all terminology used in Test Orchestration.
Includes:
Technical terms explained
Platform-specific concepts
Business terminology
Acronyms and abbreviations
Use when: You encounter unfamiliar terms or want to clarify concepts.
Frequently Asked Questions covering common topics and scenarios.
Includes:
How-to questions
Capability clarifications
Best practice recommendations
Workflow guidance
Use when: You need quick answers to common questions.
Diagnostic guides and solutions for common problems.
Includes:
Error messages explained
Debugging strategies
Common issues and fixes
Performance optimization
Diagnostic commands
Use when: Something isn't working as expected.
Navigation Guide
By User Role
Workflow Developers: → Start with Getting Started → Reference CLI Reference for automation → Check Glossary for terms
System Administrators: → Check CLI Reference for configuration → Review Troubleshooting for issues → Reference Glossary for architecture terms
QA Engineers: → Use FAQs for common workflows → Check Glossary for testing terms → Reference Troubleshooting for test failures
By Task
🎯 Find Answers Fast
Know what you're trying to do? Use this quick task index to find the right reference.
Automate workflows
Understand a term
Quick answers
Fix a problem
Learn concepts
Learn features
Quick Search
Looking for...
Need to automate with CLI?
Includes:
Command syntax
Common workflows
Environment variables
Examples
What does this term mean?
→ Glossary
Includes:
Technical terms
Platform concepts
Business terminology
Acronyms
Common questions answered?
→ FAQs
Includes:
How-to questions
Capability questions
Best practices
Workflow guidance
Something isn't working?
Includes:
Error explanations
Debugging steps
Common fixes
Diagnostic tips
Key Concepts
Projects
Containers for organizing workflows and settings. See Glossary: Project.
Workflows
Sequences of steps that automate processes. See Glossary: Workflow.
Nodes and Steps
Building blocks of workflows. See Glossary: Nodes.
Execution Flow
How workflows run and progress. See Glossary: Execution Flow.
Helpful Resources
Documentation Sections
Getting Started - For beginners
Core Concepts - Foundational knowledge
Features - Platform capabilities
Action Types - Available actions
Advanced Topics - Advanced techniques
Use Cases & Examples - Real-world scenarios
External Resources
Support Portal - https://support.qyrus.com
Community Forum - https://community.qyrus.com
GitHub Repository - https://github.com/qyrus
Common Workflows
Get Help for a Command
See CLI Reference for all commands.
Understand a Term
Go to Glossary
Search for the term
Read the definition
Follow cross-references if needed
Find Answer to Common Question
Check FAQs
Search by category
Read question and answer
Follow links for more info
Diagnose a Problem
Note the error message
Go to Troubleshooting
Find matching symptom
Follow diagnostic steps
Apply suggested solution
Information Organization
By Frequency
Daily Use:
Occasional Reference:
By Complexity
Beginner:
Intermediate:
CLI Reference - Command documentation
Troubleshooting - Problem solving
Advanced:
CLI Reference - Advanced options
Troubleshooting - Deep diagnostics
Index of Topics
CLI & Commands
Terminology
Common Questions
Problem Solving
Best Practices for Reference Usage
✅ Do
Use search - Find what you need quickly
Check related topics - Follow cross-references
Read examples - Understand practical usage
Check glossary - Look up unfamiliar terms
Try suggested solutions - Follow troubleshooting steps
❌ Don't
Rely only on reference - Read guides for complete learning
Skip fundamentals - Understand concepts first
Ignore error messages - They provide clues
Guess at CLI options - Check documentation
Assume outdated info - Check dates on reference
Getting Help
Documentation
For comprehensive guidance:
Quick References
For quick information:
Problem Solving
For issues and troubleshooting:
Community Help
Support Portal - https://support.qyrus.com
Community Forum - https://community.qyrus.com
Summary
Reference section provides quick access to technical information
CLI Reference - Command documentation
Glossary - Term definitions
FAQs - Common questions
Troubleshooting - Problem solutions
Navigate by task - Find what you need quickly
Start with: CLI Reference for command documentation, or FAQs for common questions.
Last updated