Skip to content

chore: rename CLI repo #83

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

Merged
jy-tan merged 1 commit into from
Mar 21, 2026
Merged

chore: rename CLI repo #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions .github/workflows/e2e.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ jobs:
id: tusk-version
run: |
VERSION=$(curl -s -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
"https://api.github.com/repos/Use-Tusk/tusk-drift-cli/releases/latest" \
"https://api.github.com/repos/Use-Tusk/tusk-cli/releases/latest" \
| grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/')
echo "version=$VERSION" >> $GITHUB_OUTPUT
echo "Latest Tusk CLI version: $VERSION"
Expand Down Expand Up @@ -195,7 +195,7 @@ jobs:
id: tusk-version
run: |
VERSION=$(curl -s -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
"https://api.github.com/repos/Use-Tusk/tusk-drift-cli/releases/latest" \
"https://api.github.com/repos/Use-Tusk/tusk-cli/releases/latest" \
| grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/')
echo "version=$VERSION" >> $GITHUB_OUTPUT
echo "Latest Tusk CLI version: $VERSION"
Expand Down Expand Up @@ -299,7 +299,7 @@ jobs:
id: tusk-version
run: |
VERSION=$(curl -s -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
"https://api.github.com/repos/Use-Tusk/tusk-drift-cli/releases/latest" \
"https://api.github.com/repos/Use-Tusk/tusk-cli/releases/latest" \
| grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/')
echo "version=$VERSION" >> $GITHUB_OUTPUT
echo "Latest Tusk CLI version: $VERSION"
Expand Down
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<a href="https://join.slack.com/t/tusk-community/shared_invite/zt-3fve1s7ie-NAAUn~UpHsf1m_2tdoGjsQ"><img src="https://img.shields.io/badge/slack-badge?style=flat&logo=slack&label=Tusk&color=BF40BF" alt="Tusk Community Slack"></a>
</p>

The Python Tusk Drift SDK enables fast and deterministic API testing by capturing and replaying API calls made to/from your service. Automatically record real-world API calls, then replay them as tests using the [Tusk CLI](https://github.com/Use-Tusk/tusk-drift-cli) to find regressions. During replay, all outbound requests are intercepted with recorded data to ensure consistent behavior without side-effects.
The Python Tusk Drift SDK enables fast and deterministic API testing by capturing and replaying API calls made to/from your service. Automatically record real-world API calls, then replay them as tests using the [Tusk CLI](https://github.com/Use-Tusk/tusk-cli) to find regressions. During replay, all outbound requests are intercepted with recorded data to ensure consistent behavior without side-effects.

<div align="center">

Expand Down Expand Up @@ -67,7 +67,7 @@ If you're using packages or versions not listed above, please create an issue wi

### Step 1: Install the CLI

First, install the Tusk Drift CLI by following our [CLI installation guide](https://github.com/Use-Tusk/tusk-drift-cli?tab=readme-ov-file#install).
First, install the Tusk Drift CLI by following our [CLI installation guide](https://github.com/Use-Tusk/tusk-cli?tab=readme-ov-file#install).

### Step 2: Set up Tusk Drift

Expand All @@ -78,7 +78,7 @@ Use our AI agent to automatically set up Tusk Drift for your service:
```bash
cd path/to/your/service
export ANTHROPIC_API_KEY=your-api-key
tusk setup
tusk drift setup
```

The agent will analyze your codebase, install the SDK, instrument it into your application, create configuration files, and test the setup with recording and replay.
Expand All @@ -99,7 +99,7 @@ Alternatively, you can set up Tusk Drift manually:

*For more information about Rust acceleration, refer to [this doc](docs/rust-core-bindings).*

2. Create configuration: Run `tusk init` to create your `.tusk/config.yaml` config file interactively, or create it manually per the [configuration docs](https://github.com/Use-Tusk/tusk-drift-cli/blob/main/docs/configuration.md).
2. Create configuration: Run `tusk init` to create your `.tusk/config.yaml` config file interactively, or create it manually per the [configuration docs](https://github.com/Use-Tusk/tusk-cli/blob/main/docs/drift/configuration.md).

3. Initialize the SDK: Refer to the [initialization guide](docs/initialization.md) to instrument the SDK in your service.

Expand Down
4 changes: 2 additions & 2 deletions docs/initialization.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
Before setting up the SDK, ensure you have:

- Python 3.9 or later installed
- Installed the [Tusk Drift CLI](https://github.com/Use-Tusk/tusk-drift-cli?tab=readme-ov-file#install)
- Installed the [Tusk Drift CLI](https://github.com/Use-Tusk/tusk-cli?tab=readme-ov-file#install)
- Obtained an API key from the [Tusk Drift dashboard](https://usetusk.ai/app/settings/api-keys) (only required if using Tusk Cloud)

> [!TIP]
> For automated setup, use `tusk setup` which handles SDK installation and initialization for you.
> For automated setup, use `tusk drift setup` which handles SDK installation and initialization for you.
> The steps below are for manual setup.

## Step 1: Install the SDK
Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ You should see an output similar to:

Press `ESC` to exit the list view.

Need to install the Tusk CLI? See [CLI installation guide](https://github.com/Use-Tusk/tusk-drift-cli?tab=readme-ov-file#install).
Need to install the Tusk CLI? See [CLI installation guide](https://github.com/Use-Tusk/tusk-cli?tab=readme-ov-file#install).

## Step 6: Replay the Trace

Expand Down
6 changes: 3 additions & 3 deletions drift/instrumentation/e2e_common/Dockerfile.base
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ ARG TUSK_CLI_VERSION=latest
RUN set -ex && \
if [ "$TUSK_CLI_VERSION" = "latest" ]; then \
# Get the latest version tag
VERSION=$(curl -s https://api.github.com/repos/Use-Tusk/tusk-drift-cli/releases/latest | grep '"tag_name"' | cut -d '"' -f 4); \
VERSION=$(curl -s https://api.github.com/repos/Use-Tusk/tusk-cli/releases/latest | grep '"tag_name"' | cut -d '"' -f 4); \
else \
VERSION="${TUSK_CLI_VERSION}"; \
fi && \
Expand All @@ -37,8 +37,8 @@ RUN set -ex && \
aarch64|arm64) ARCH_NAME="arm64" ;; \
*) echo "Unsupported architecture: $ARCH" && exit 1 ;; \
esac && \
# Construct download URL (archives are named like tusk-drift-cli_0.1.35_Linux_x86_64.tar.gz)
DOWNLOAD_URL="https://github.com/Use-Tusk/tusk-drift-cli/releases/download/${VERSION}/tusk-drift-cli_${VERSION_NUM}_Linux_${ARCH_NAME}.tar.gz" && \
# Construct download URL (archives are named like tusk-cli_0.1.35_Linux_x86_64.tar.gz)
DOWNLOAD_URL="https://github.com/Use-Tusk/tusk-cli/releases/download/${VERSION}/tusk-cli_${VERSION_NUM}_Linux_${ARCH_NAME}.tar.gz" && \
echo "Downloading Tusk CLI from: $DOWNLOAD_URL" && \
curl -fsSL "$DOWNLOAD_URL" -o /tmp/tusk.tar.gz && \
tar -xzf /tmp/tusk.tar.gz -C /tmp && \
Expand Down
Loading