Connapse.CLI 0.4.3

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. 
dotnet tool install --global Connapse.CLI --version 0.4.3
This package contains a .NET tool you can call from the shell/command line. 
dotnet new tool-manifest
                    


                            if you are setting up this repo
                        

                    

                
dotnet tool install --local Connapse.CLI --version 0.4.3
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=Connapse.CLI&version=0.4.3
                    


                    

                
nuke :add-package Connapse.CLI --version 0.4.3

connapse-cli

Command-line interface for Connapse — an AI-powered knowledge management platform.

The CLI works with both Connapse Cloud (multi-tenant) and self-hosted Connapse servers.

Install

Option 1: .NET global tool (requires .NET 10 SDK)

dotnet tool install -g Connapse.CLI
connapse --version

Upgrade later with:

dotnet tool update -g Connapse.CLI

Option 2: Self-contained binary (no .NET required)

Download the binary for your platform from the latest release:

Platform Asset
Windows (x64) connapse-cli-win-x64.exe
Linux (x64) connapse-cli-linux-x64
macOS (Intel) connapse-cli-osx-x64
macOS (Apple Silicon) connapse-cli-osx-arm64

On Linux or macOS:

chmod +x connapse-cli-linux-x64
sudo mv connapse-cli-linux-x64 /usr/local/bin/connapse

On Windows, add the .exe to a directory in your PATH.

Option 3: Build from source

git clone https://github.com/Destrayon/connapse-cli
cd connapse-cli
dotnet build Connapse.Cli.slnx
dotnet run --project src/Connapse.Cli -- --help

Quick start

# 1. Log in to your Connapse server. A browser opens for OAuth; on completion
#    the CLI stores credentials in ~/.connapse/credentials.json.
connapse auth login --server https://www.connapse.com

# 2. (Cloud only) Pick an organization as the default for subsequent commands.
connapse org list
connapse org switch my-org

# 3. Create a knowledge container.
connapse container create "my-docs" --description "Project documentation"

# 4. Upload a file or directory.
connapse upload ./docs --container my-docs --destination /guides

# 5. Wait for indexing to finish, then search.
connapse search "how do I configure X" --container my-docs --top 5

Commands

All commands accept the global options --org <slug> and --verbose. Commands that require authentication will exit with status code 2 and ask you to run connapse auth login if credentials are missing or invalid.

Authentication

Command Description
connapse auth login --server <url> Open a browser for OAuth login.
connapse auth login --server <url> --with-token Read a pre-generated token from stdin (CI-friendly).
connapse auth logout Clear stored credentials.
connapse auth whoami Show the current identity and server.
connapse auth pat create <name> [--expires yyyy-MM-dd] Create a personal access token.
connapse auth pat list List all personal access tokens.
connapse auth pat revoke <id> Revoke a personal access token by ID.

Organizations (Cloud only)

Command Description
connapse org list List organizations you belong to.
connapse org switch <slug> Set the default organization.
connapse org current Print the current default organization slug.

Organization commands are no-ops on self-hosted servers and exit 0 with a friendly message.

Containers

Command Description
connapse container create <name> [--description ...] Create a knowledge container.
connapse container list List all containers in the current organization.
connapse container delete <name> Delete a container (accepts name or ID).
connapse container stats <name> Show document counts, chunks, size, and embedding info.

Files

Command Description
connapse files list --container <name> [--path /folder] List files and folders in a container.
connapse files get --container <name> --file <id-or-path> Print a file's text content.
connapse files delete --container <name> --file <guid> Delete a file by ID.

Content

Command Description
connapse upload <path> --container <name> [--destination /] [--strategy Semantic] Upload a file or directory.
connapse search "<query>" --container <name> [--mode Hybrid] [--top 10] [--path /x] [--min-score 0.5] Search inside a container.
connapse reindex --container <name> [--force] [--no-detect-changes] Re-process all documents.

Housekeeping

Command Description
connapse version Print the installed CLI version.
connapse update Check for and install a newer version from GitHub.
connapse update --check Check for a newer version without installing.
connapse update --include-prerelease Include pre-release versions.

Configuration

File locations

File Purpose
~/.connapse/credentials.json API key, refresh token, server URL, user email. File mode 0600 on Unix.
~/.connapse/config.json Default org slug, cached edition, last-update-check timestamp.

On Windows these live under %USERPROFILE%\.connapse\.

Environment variables

Variable Effect
CONNAPSE_ORG Sets the target organization for all commands. Overridden by --org.

Global flags

Flag Effect
--org <slug> Override organization for a single command.
--verbose Print full stack traces for unexpected errors.

Exit codes

Code Meaning
0 Success.
1 User error (bad input, server-rejected request, partial failure).
2 Authentication failure — run connapse auth login to fix.
99 Unexpected error. Re-run with --verbose to see the stack trace.

Contributing

Bug reports and pull requests are welcome at https://github.com/Destrayon/connapse-cli/issues.

Releases

Releases are published via a tag push to main:

git tag v0.5.0
git push origin v0.5.0

The .github/workflows/release.yml workflow builds four self-contained binaries, packs a NuGet global tool, and creates a GitHub Release with all five assets.

NuGet publish requires the NUGET_API_KEY secret. Create a scoped API key at nuget.org/account/apikeys (glob pattern Connapse.CLI*) and set it on the repo:

gh secret set NUGET_API_KEY --repo Destrayon/connapse-cli

If the secret is missing the release workflow still succeeds — the NuGet publish step is skipped, but binary assets are still attached to the release.

License

MIT. See LICENSE.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.