arcl 1.7.9

The CLI for Archimedes

Archimedes CLI

The Archimedes CLI tool is used to bootstrap archimedes projects. The projects are based on a template available here.

The CLI tool also helps you authenticate using your organization credentials and get credentials to access the Archimedes API and the database.

Installation

Archimedes-cli can be installed on Linux, macOS and Windows. Follow the instructions for your operating system:

• Install arcl on Linux
• Install arcl on macOS
• Install arcl on Windows

Post-installation setup

After installation of arcl tool, you will need to install and configure some other tools to be able to use arcl on your operating system. Please follow the instructions below:

• Post-install setup on Linux
• Post-install setup on macOS
• Post-install setup on Windows

Usage

arcl --help

Login

To login to Archimedes, which is required for using it, run the following command and follow the on-screen instructions:

arcl auth login optimeering

To login to the DEV environment:

arcl auth logout
ENVIRONMENT=dev arcl auth login optimeering

Dev setup

pyenv shell 3.10.8
pip install --upgrade pip wheel
pyenv rehash
poetry install
poetry shell
arcl --help

Publishing releases

A new release can be made by creating a release using the GitHub web interface.

When the release it created, as long as the tag naming convention is followed, it is automatically built and published to pypi by GitHub Actions, which is configured in the .github/workflows in this repo. Please refer to the following instructions when making releases:

• Make sure that pyproject.toml is updated with a new version. We use semantic versioning. Make sure the version hasn't already been published to pypi.
• Go to the Releases page of the project
• Click the Create a new release button
• Click on Choose a tag and in the input field, enter release/cli/v{VERSION_NUMBER_FROM_pyproject.toml}, for e.g. release/v1.2.3. This tag name should NOT already exist, so it will NOT appear in the dropdown menu which appears as you enter text. You need to click on Create new tag release/cli/v{VERSION_NUMBER_FROM_pyproject.toml} on publish to create the tag.
• In the release title, write v{VERSION_NUMBER_FROM_pyproject.toml}, for e.g. v1.2.3.
• In Release Notes, ideally, we should write the titles of all the Shortcut stories and link to them.
• Click on the Publish Release button.
• Then, check that the release pipeline is running and wait for it to complete successfully.
• Verify the release is published to pypi.
• New arcl version has now been released.
• Then, you are ready to build and publish the Windows distribution of arcl, which we currently perform manually. See here for instructions on how to do that.