Skip to content

Clarify project download commands and add an archive alias #2

Description

@dkritarth

Problem

The CLI currently exposes overlapping terminology for project downloads:

  • pull means extract a project into a local directory
  • zip means download the raw archive
  • single-file download exists separately

For new users, the archive-vs-workspace split is not obvious. The command names and help text do not clearly communicate which workflow is for sync/extraction and which is for archive export.

Current behavior

  • olcli pull [project] [dir] downloads and extracts a project into a directory
  • olcli zip [project] downloads a zip archive
  • olcli download <file> downloads a single file

Expected behavior

  • Keep existing commands working for backward compatibility.
  • Add a clearer canonical project-archive command name, such as archive.
  • Keep zip as a compatibility alias if the canonical name changes.
  • Update help text and docs so the CLI clearly separates:
    • workspace sync / extraction
    • archive export
    • single-file download

Acceptance criteria

  • olcli archive exists and behaves like the current zip command.
  • olcli zip continues to work as an alias.
  • Help output groups commands by intent and uses clearer wording.
  • README and command docs are updated to explain the difference between archive export and workspace pull.
  • Error/spinner messages use user-facing language rather than implementation terms.

Notes

This is a UX and command-shape issue, not a breaking redesign. Existing scripts and aliases should remain valid.


Generated by GPT-5.4 mini.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions