Welcome to the tpcli documentation! This documentation is organized using the Diátaxis framework for clarity and ease of navigation.
📚 Tutorials - Learning-Oriented
Step-by-step guides to get started and understand core concepts.
- 01-getting-started.md - Installation and first run
- 02-basic-queries.md - Your first API queries
- 03-authentication-setup.md - Setting up auth properly
🎯 How-To Guides - Task-Oriented
Practical instructions for accomplishing specific tasks.
- discover-pi-structure.md - Explore PI planning hierarchies by ART/team/release
- work-with-user-stories.md - CRUD operations on User Stories
- manage-assignments.md - Assign users and teams to work items
- manage-work-items.md - Update properties, dates, priorities, tags
- work-with-collections.md - Access and manage related entities
- paginate-results.md - Handle large result sets efficiently
- api-use-cases.md - Common workflows and patterns
- list-and-filter.md - Query, filter, and search entities
📖 Reference - Information-Oriented
Lookup documentation for quick answers.
- user-story-structure.md - User Story fields, relationships, and collections
- api-v1-reference.md - REST API v1 complete reference
- api-v2-reference.md - REST API v2 (read-only) reference
- entity-types.md - All available entity types
- query-syntax.md - Filter expressions and operators
- auth-methods.md - Authentication options and formats
- auth-troubleshooting.md - Resolving authentication issues
💡 Explanation - Understanding-Oriented
Conceptual information to build understanding.
- data-model.md - TargetProcess entity hierarchy
- api-architecture.md - How the API works
- entity-relationships.md - How entities relate
🚀 Ideas & Proposals - Future-Oriented
Feature proposals, enhancement ideas, and design discussions.
- entity-discovery-helpers.md - Instance-agnostic entity lookup helpers
- Browse all Ideas & Proposals
New to tpcli? → Start with Tutorials
Know what you want to do? → Browse How-To Guides
Need to look something up? → Check Reference
Want to understand concepts? → Read Explanation
Have an idea or proposal? → See Ideas & Proposals
Understand PI planning structure for my team/ART/release → discover-pi-structure.md
Get started with tpcli → 01-getting-started.md
Work with User Stories (create, read, update, delete) → work-with-user-stories.md
Access collections (bugs, tasks, comments, times) → work-with-collections.md
Understand User Story structure and fields → user-story-structure.md
List all user stories with filtering → list-and-filter.md
Handle pagination for large results → paginate-results.md
Find items created in the last week → list-and-filter.md#date-filters
Include related project information → work-with-nested-entities.md
Understand the TargetProcess data structure → data-model.md
Set up API authentication → 03-authentication-setup.md
Troubleshoot authentication issues → auth-troubleshooting.md
Assign users/teams to work items → manage-assignments.md
Update dates, priorities, tags, effort → manage-work-items.md
Follow common API patterns and workflows → api-use-cases.md
See all available filters → query-syntax.md
Get details about an entity type → entity-types.md
Each guide follows a consistent format:
- Tutorials: Follow a step-by-step learning path
- How-To: Task-focused with examples and explanations
- Reference: Organized for easy lookup, alphabetical or logical
- Explanation: Conceptual, building understanding
- tpcli: 0.1.0 (MVP)
- TargetProcess API: v1 & v2
- Last Updated: November 29, 2025
- Project README:
~/shalomb/tpcli/README.md - Project Summary:
~/shalomb/tpcli/PROJECT-SUMMARY.md - TargetProcess API Docs: https://dev.targetprocess.com/docs
- Diátaxis Framework: https://diataxis.fr/
Start reading: Getting Started Tutorial →