Skip to content

Feature/cross platform installation scripts #351

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bishoy-at-pieces wants to merge 26 commits into
base: main
Choose a base branch
from
Open

Feature/cross platform installation scripts #351

Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
bd82371
feat: Add cross-platform installation scripts
bishoy-at-pieces Jul 9, 2025
5b625cf
feat: Add manage command group with update, status, and uninstall
bishoy-at-pieces Jul 9, 2025
67a58ba
feat: Integrate manage command into CLI
bishoy-at-pieces Jul 9, 2025
fd6923b
docs: Update README with installation scripts and manage command
bishoy-at-pieces Jul 9, 2025
b9aa430
add update POS command
bishoy-at-pieces Jul 9, 2025
2fe3b41
add pieces status to the manage update command
bishoy-at-pieces Jul 9, 2025
edc982f
fix formating
bishoy-at-pieces Jul 9, 2025
db83732
add change the structure of the commands (pieces update) to update Pi…
bishoy-at-pieces Jul 14, 2025
b263422
Merge branch 'main' into feature/cross-platform-installation-scripts
bishoy-at-pieces Jul 14, 2025
6f49ab1
Merge branch 'main' into feature/cross-platform-installation-scripts
bishoy-at-pieces Jul 14, 2025
8e7d159
fix weak python version parsing
bishoy-at-pieces Jul 14, 2025
f5f9503
add new choco and winget in the manage command
bishoy-at-pieces Jul 14, 2025
cfc3841
add cleanup function
bishoy-at-pieces Jul 14, 2025
4034f17
Fix security issues in PATH manipulation:
bishoy-at-pieces Jul 14, 2025
3f457ac
ensure reliability in the installation scripts
bishoy-at-pieces Jul 15, 2025
5bfa8af
Merge branch 'main' into feature/cross-platform-installation-scripts
bishoy-at-pieces Jul 15, 2025
927a234
fix colors in the status
bishoy-at-pieces Jul 15, 2025
de7d866
ensure reliablity in the sh script
bishoy-at-pieces Jul 15, 2025
0143854
refactor: Modularize manage commands into separate files
bishoy-at-pieces Jul 15, 2025
1e3956b
fix: Skip onboarding for completion command
bishoy-at-pieces Jul 15, 2025
d7afe69
Docs & Security Helpers For Inspo
tsavo-at-pieces Jul 18, 2025
d5bed75
comment the installer script method until it is save
bishoy-at-pieces Jul 23, 2025
394d274
Merge branch 'main' into feature/cross-platform-installation-scripts
bishoy-at-pieces Aug 28, 2025
9f0c329
add checksums and installation security
bishoy-at-pieces Aug 28, 2025
0bf485f
feat: add dependency logging
bishoy-at-pieces Aug 28, 2025
2ca25d3
fix: resolve Path.exists patching issues in executable location tests
bishoy-at-pieces Aug 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 23 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
</p>

##### <p align="center"> [Website](https://pieces.app/) • [PiecesOS Documentation](https://docs.pieces.app/) • [Pieces CLI Documentation](https://docs.pieces.app/extensions-plugins/cli)

</p>

[![Introducing CLI](https://img.youtube.com/vi/kAgwHMxWY8c/0.jpg)](https://www.youtube.com/watch?v=kAgwHMxWY8c)
Expand All @@ -30,6 +31,22 @@ To get started with the Pieces Python CLI Tool, you need to:
1. Ensure PiecesOS is installed and running on your system.
2. Install the Python package:

**Installer Script (Recommended):**

> **Requirements:** Python 3.11 or higher is required for the installation scripts.

```bash
# macOS/Linux
curl -fsSL https://raw.githubusercontent.com/pieces-app/cli-agent/main/install_pieces_cli.sh | sh
Copy link
Collaborator Author

@bishoy-at-pieces bishoy-at-pieces Jul 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tsavo-at-pieces @mack-at-pieces Do we want to give it another url something like https://pieces.app/cli/install?

Copy link
Contributor

@tsavo-at-pieces tsavo-at-pieces Jul 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we do it through the builds server. Have you gotten with @nathan-courtney-pieces on this ?

Copy link
Collaborator Author

@bishoy-at-pieces bishoy-at-pieces Jul 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tsavo-at-pieces if you want to test it

curl -fsSL https://raw.githubusercontent.com/pieces-app/cli-agent/feature/cross-platform-installation-scripts/install_pieces_cli.sh | sh

Copy link
Contributor

@nathan-courtney-pieces nathan-courtney-pieces Jul 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tsavo-at-pieces You want to host it in GCP then have the builds server create a link to it?

We can get that in but note that the Attribution tracking stuff is currently on staging

Copy link
Contributor

@tsavo-at-pieces tsavo-at-pieces Jul 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

DETAILED SOLUTION:

Current Code (Line 39):

curl -fsSL https://raw.githubusercontent.com/pieces-app/cli-agent/main/install_pieces_cli.sh | sh

Change To:

# Secure Installation with Verification

# Option 1: Full verification process
VERSION="1.2.3"  # Pin to specific version
BASE_URL="https://github.com/pieces-app/cli-agent/releases/download/v${VERSION}"

# Download files
curl -fsSL "${BASE_URL}/install_pieces_cli.sh" -o install_pieces_cli.sh
curl -fsSL "${BASE_URL}/install_pieces_cli.sh.sha256" -o install_pieces_cli.sh.sha256

# Verify checksum
sha256sum -c install_pieces_cli.sh.sha256 || exit 1

# Execute after verification
sh install_pieces_cli.sh

# Cleanup
rm -f install_pieces_cli.sh install_pieces_cli.sh.sha256

Option 2: For README simplicity, provide a secure wrapper:

# This would call a script that does verification internally
curl -fsSL https://pieces.app/install.sh | sh -s -- --verify

Required Infrastructure Changes:

  1. Create checksums for each release: sha256sum install_pieces_cli.sh > install_pieces_cli.sh.sha256
  2. Upload both files to GitHub releases
  3. Consider GPG signing for additional security
  4. Create secure wrapper script at pieces.app domain with built-in verification

```

```powershell
# Windows (PowerShell)
irm https://raw.githubusercontent.com/pieces-app/cli-agent/main/install_pieces_cli.ps1 | iex
```

**Package Managers:**

```bash
pip install pieces-cli
```
Expand Down Expand Up @@ -63,26 +80,30 @@ pieces completion [shell]
**Quick setup commands for each shell:**

- **Bash:**

```bash
echo 'eval "$(pieces completion bash)"' >> ~/.bashrc && source ~/.bashrc
```

- **Zsh:**

```zsh
echo 'eval "$(pieces completion zsh)"' >> ~/.zshrc && source ~/.zshrc
```

- **Fish:**

```fish
echo 'pieces completion fish | source' >> ~/.config/fish/config.fish && source ~/.config/fish/config.fish
```

- **PowerShell:**

```powershell
Add-Content $PROFILE '$completionPiecesScript = pieces completion powershell | Out-String; Invoke-Expression $completionPiecesScript'; . $PROFILE
```

After setup, restart your terminal or source your configuration file. Then try typing `pieces ` and press **Tab** to test auto-completion!
After setup, restart your terminal or source your configuration file. Then try typing `pieces` and press **Tab** to test auto-completion!

## Usage

Expand Down Expand Up @@ -198,7 +219,7 @@ coverage report
To uninstall the project, run the following command:

```shell
pip uninstall pieces-cli
pieces manage uninstall
```

Don't forget to remove the virtual environment and dist folder
Expand Down
Loading