Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

ara-cli

ara-cli is a powerful, open source command-line tool for managing, structuring and automating software development artifacts in line with Behavior-Driven Development (BDD) and AI-assisted processes. With an intuitive interface and platform-independent implementation in Python, ara-cli enables teams to structure business goals, capabilities, features, user stories, and tasks, and to leverage integrated AI/chat capabilities for requirements engineering, documentation, and process automation.


Features

  • Comprehensive Artefact Management:
    Create, edit, rename, delete, and list all core artefacts of the software development lifecycle: businessgoals, vision, capabilities, keyfeatures, features, epics, userstories, examples, and tasks.

  • Structured Traceability:
    Organize and link artefacts for full traceability from business goals to implementation tasks. Effortlessly navigate artefact hierarchies and dependencies.

  • Integrated AI and Chat:
    Interact with AI language models directly from your terminal. Use chat and prompt commands to assist with documentation, requirements refinement, and artefact management.

  • Prompt Templates:
    Fetch, use, and manage reusable prompt templates for consistent and efficient requirements and documentation workflows.

  • Artefact Status and User Management:
    Assign and query status and responsible users for artefacts to support project coordination and tracking.

  • Automated Quality Assurance:
    Scan artefact trees for inconsistencies and automatically correct issues using integrated LLM-powered autofix functionality.

  • Powerful Listing and Search:
    List artefacts and filter by type, tags, content, contributor relationships, file extensions, and more.

  • Open Source & Platform Independent:
    Implemented in Python and available on PyPI for easy installation and integration into any workflow.


Use Cases

  • Requirements Engineering:
    Capture and structure business requirements and user stories with clear traceability.

  • Agile Development:
    Manage and automate backlog refinement, sprint planning, and task tracking.

  • AI-Enhanced Productivity:
    Use chat and prompt features to accelerate documentation, code review, and knowledge management.

  • Quality Management:
    Ensure artefact consistency and high documentation quality via automated scans and fixes.


Quick Start

Install from PyPI:

pip install ara-cli

Create your first feature artefact:

ara create feature login

List all features:

ara list --include-extension .feature

Chat with the integrated AI:

ara chat

Scan and autofix artefacts:

ara scan
ara autofix

Command Overview

Action Description
create Create a classified artefact with data directory
delete Delete an artefact and its data directory
rename Rename an artefact and its data directory
list, list-tags List artefacts, show tags, filter by content, extension, hierarchy etc.
prompt, chat Use AI-powered chat and prompt templates for artefact management
template Print artefact templates in the terminal
fetch-templates Download and manage reusable prompt templates
read Output artefact contents and their full contribution chain
reconnect Connect artefacts to parent artefacts
read-status, set-status Query and assign status to artefacts
read-user, set-user Query and assign responsible users
classifier-directory Show directory of artefact classifiers
scan Scan the ARA tree for incompatible or inconsistent artefacts
autofix Automatically correct artefact issues with LLM assistance

See ara -h for the complete list of commands and usage examples.


Agent Commands

ara-cli includes powerful agent-based capabilities that can be accessed through the interactive chat. These agents can perform complex, multi-step tasks, such as conducting interviews or automating coding workflows.

To use the agent commands, first start an interactive chat session:

ara prompt chat <artefact_classifier> <artefact_name>

Once inside the chat, you can use the following commands to manage agents:

Command Shortcut Description
AGENT_RUN a Run an agent by name.
AGENT_STOP as Stop the currently running agent.
AGENT_CONTINUE ac Continue the agent's operation without new input.
AGENT_STATUS astat Show the status of the current agent.
exit Exit from agent interfacto back to chat.

Example:

ara> a interview_agent

Important: The agent functionality requires the ara-agents package to be installed separately. If you do not have ara-agents installed, please contact the Talsen Team for assistance.


Artefact Structure

ara-cli organizes your project artefacts in a clear directory structure:

./ara/
   ├── businessgoals/
   ├── vision/
   ├── capabilities/
   ├── keyfeatures/
   ├── features/
   ├── epics/
   ├── userstories/
   ├── examples/
   ├── tasks/

Example Workflows

  • Create a new feature and link it to a user story:
ara create feature payment contributes-to userstory checkout
  • Read an artefact's content and its full parent chain:
ara read task implement_api --branch
  • List tasks containing specific content:
ara list --include-extension .task --include-content "API integration"
  • Automate prompt-based LLM interaction for a task:
ara prompt send task implement_api
ara prompt extract task implement_api

Requirements

  • Python 3.8+
  • Platform-independent; tested on Linux, macOS, and Windows

License

This project is open source and freely available under the MIT License.



Contributing

Contributions, issues, and feature requests are welcome! Please open an issue or submit a pull request via GitHub.


ara-cli — Structure your development. Automate with AI. Build better software.

Metadata

Release files for ara-cli 0.1.18.2rc2701

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ara-cli 0.1.18.2rc2701
File Size Uploaded Provenance Actions
ara_cli-0.1.18.2rc2701.tar.gz 260.6 kB Without provenance Details for ara_cli-0.1.18.2rc2701.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ara-cli 0.1.18.2rc2701
File Interpreter ABI Platform Actions
ara_cli-0.1.18.2rc2701-py3-none-any.whl Python 3 none any Details for ara_cli-0.1.18.2rc2701-py3-none-any.whl

Total release size: 615.6 kB

Release files / ara_cli-0.1.18.2rc2701.tar.gz

Download URL ara_cli-0.1.18.2rc2701.tar.gz
Size 260.6 kB
Tags Source
SHA-256 checksum
How to use checksums
864fb2c8218ee65f87c3719825db496ae3b98a811e77c127103555ef8b0b3e6f
BLAKE2b-256 checksum
How to use checksums
cf0117a9dfc058b0b456be7a43ebfc5bc2056382947bb1c63cabfb0d5f1fefbf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release files / ara_cli-0.1.18.2rc2701-py3-none-any.whl

Download URL ara_cli-0.1.18.2rc2701-py3-none-any.whl
Size 355.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c8d5adb65c116fac061599e9a336fb5c32b876a5be3b1255fe9e44c7112d3e7f
BLAKE2b-256 checksum
How to use checksums
2992ea488f0417490c5b6e08bce9f44a58b22f740e7a40f5b205cb5b205a5eaf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Security for ara-cli 0.1.18.2rc2701

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page