add in-app "Install clide command in PATH" affordance (T-212)
A command-palette / `clide` CLI verb (`clide.installCli`) copies the bundled C client into ~/.local/bin, VS Code "Install code command" style, so a user who runs the app without `make install` can still reach the CLI from a shell. On launch the app detects when `clide` is missing from PATH or resolves to a stale symlink into the Flutter GUI bundle (the dogfood footgun: a bare `clide` launched a second app instead of querying the socket) and notifies with a pointer to the command. `make build` now ships the C client inside the app bundle so the affordance can self-install from it; `make run` points it at the dev-tree client via CLIDE_CLI_BIN. Detection and the copy live in the Flutter-free CliInstaller (kernel/src/cli_install.dart) so they run under unit tests without a real install. Closes epic T-209 (ship the clide CLI on PATH). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1 @@
|
||||
export 'src/extension.dart';
|
||||
@@ -0,0 +1,84 @@
|
||||
import 'dart:io';
|
||||
|
||||
import 'package:clide/clide.dart';
|
||||
import 'package:clide/extension/extension.dart';
|
||||
import 'package:clide/kernel/src/cli_install.dart';
|
||||
|
||||
/// VS Code-style "Install 'clide' command in PATH" affordance (T-212).
|
||||
///
|
||||
/// Registers a palette/CLI command that copies the bundled C client into a
|
||||
/// PATH dir, and on activation proactively warns when `clide` is missing from
|
||||
/// PATH or — the dogfood footgun — resolves to a stale symlink into the
|
||||
/// Flutter GUI bundle instead of the C client. Detection and the copy live in
|
||||
/// the Flutter-free [CliInstaller]; this extension only wires it to the
|
||||
/// command and notification surfaces.
|
||||
class CliInstallExtension extends ClideExtension {
|
||||
CliInstallExtension({CliInstaller? installer}) : _installer = installer;
|
||||
|
||||
CliInstaller? _installer;
|
||||
ClideExtensionContext? _ctx;
|
||||
|
||||
CliInstaller get _resolved => _installer ??= CliInstaller(resolvedExecutable: Platform.resolvedExecutable);
|
||||
|
||||
@override
|
||||
String get id => 'builtin.cli-install';
|
||||
@override
|
||||
String get title => 'CLI Install';
|
||||
@override
|
||||
String get version => '0.1.0';
|
||||
|
||||
@override
|
||||
Future<void> activate(ClideExtensionContext ctx) async {
|
||||
_ctx = ctx;
|
||||
// Proactive launch-time detection (desktop only). Non-modal: we notify
|
||||
// and point at the command rather than auto-installing — no surprise
|
||||
// filesystem writes (interaction-zone discipline, D-78).
|
||||
if (!(Platform.isLinux || Platform.isMacOS)) return;
|
||||
switch (_resolved.inspect().state) {
|
||||
case CliInstallState.missing:
|
||||
ctx.notify.warn(
|
||||
'The `clide` command is not on your PATH. Run "clide: Install '
|
||||
'command in PATH" from the command palette to reach it from a shell.',
|
||||
title: 'clide CLI not installed',
|
||||
);
|
||||
case CliInstallState.staleGui:
|
||||
ctx.notify.warn(
|
||||
'`clide` on your PATH points at the GUI app, not the CLI client — '
|
||||
'a bare `clide` launches a second app. Run "clide: Install command '
|
||||
'in PATH" to replace it.',
|
||||
title: 'clide CLI is stale',
|
||||
);
|
||||
case CliInstallState.installed:
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
@override
|
||||
List<ContributionPoint> get contributions => [
|
||||
CommandContribution(
|
||||
id: 'clide.installCli',
|
||||
command: 'clide.installCli',
|
||||
title: "clide: Install 'clide' command in PATH",
|
||||
run: (_) async {
|
||||
final r = _resolved.install();
|
||||
final ctx = _ctx;
|
||||
if (r.ok) {
|
||||
ctx?.notify.success(r.message, title: 'clide CLI installed');
|
||||
return IpcResponse.ok(id: '', data: {
|
||||
'installed': r.installedPath,
|
||||
'onPath': r.onPath,
|
||||
});
|
||||
}
|
||||
ctx?.notify.error(r.message, title: 'clide CLI install failed');
|
||||
return IpcResponse.err(
|
||||
id: '',
|
||||
error: IpcError(
|
||||
code: IpcExitCode.toolError,
|
||||
kind: IpcErrorKind.toolError,
|
||||
message: r.message,
|
||||
),
|
||||
);
|
||||
},
|
||||
),
|
||||
];
|
||||
}
|
||||
@@ -0,0 +1,223 @@
|
||||
/// Flutter-free logic for the "Install clide command in PATH" affordance
|
||||
/// (T-212).
|
||||
///
|
||||
/// Detects whether the `clide` shell command resolves on PATH and points at
|
||||
/// the real C client — not a stale symlink to the Flutter GUI runner, the
|
||||
/// exact footgun a live dogfood hit: a `~/.local/bin/clide` symlink into the
|
||||
/// GUI bundle launched a *second* app instead of querying the IPC socket. The
|
||||
/// installer copies the bundled C client into a PATH dir, VS Code
|
||||
/// "Install code command" style.
|
||||
///
|
||||
/// Kept Flutter-free (only `dart:io`) so it runs under `dart test`; the
|
||||
/// builtin extension wraps it with the command + notification surfaces.
|
||||
library;
|
||||
|
||||
import 'dart:io';
|
||||
|
||||
/// State of the `clide` shell command relative to the running GUI.
|
||||
enum CliInstallState {
|
||||
/// No `clide` resolves on PATH.
|
||||
missing,
|
||||
|
||||
/// `clide` resolves but points at the Flutter GUI runner, not the C
|
||||
/// client — running it launches a second app instead of querying.
|
||||
staleGui,
|
||||
|
||||
/// `clide` resolves to something that is not the GUI — assumed good.
|
||||
installed,
|
||||
}
|
||||
|
||||
/// Result of [CliInstaller.inspect]: what `clide` on PATH points at.
|
||||
class CliInstallStatus {
|
||||
const CliInstallStatus(this.state, {this.pathEntry, this.resolvedTarget});
|
||||
|
||||
final CliInstallState state;
|
||||
|
||||
/// The `clide` entry found on PATH (the symlink/file itself), if any.
|
||||
final String? pathEntry;
|
||||
|
||||
/// Where [pathEntry] resolves to after following symlinks, if any.
|
||||
final String? resolvedTarget;
|
||||
|
||||
/// True when the user should (re)install — missing or stale.
|
||||
bool get needsInstall => state != CliInstallState.installed;
|
||||
}
|
||||
|
||||
/// Result of [CliInstaller.install].
|
||||
class CliInstallResult {
|
||||
const CliInstallResult({
|
||||
required this.ok,
|
||||
required this.message,
|
||||
this.installedPath,
|
||||
this.onPath = true,
|
||||
});
|
||||
|
||||
final bool ok;
|
||||
final String message;
|
||||
final String? installedPath;
|
||||
|
||||
/// False when [installedPath]'s directory is not itself on PATH (the copy
|
||||
/// succeeded but the user must add the dir to PATH to reach `clide`).
|
||||
final bool onPath;
|
||||
}
|
||||
|
||||
/// Copies the bundled C client onto PATH and reports what `clide` currently
|
||||
/// resolves to. Every external dependency (the running executable, the
|
||||
/// environment, candidate client locations, the target dir) is injectable so
|
||||
/// the logic is unit-testable without a real install.
|
||||
class CliInstaller {
|
||||
CliInstaller({
|
||||
required this.resolvedExecutable,
|
||||
Map<String, String>? env,
|
||||
List<String>? bundledClientCandidates,
|
||||
String? installDir,
|
||||
}) : env = env ?? Platform.environment,
|
||||
bundledClientCandidates = bundledClientCandidates ?? _defaultBundledCandidates(resolvedExecutable, env ?? Platform.environment),
|
||||
installDir = installDir ?? _defaultInstallDir(env ?? Platform.environment);
|
||||
|
||||
/// Path to the running Flutter GUI executable
|
||||
/// (`Platform.resolvedExecutable`).
|
||||
final String resolvedExecutable;
|
||||
|
||||
final Map<String, String> env;
|
||||
|
||||
/// Ordered locations to look for the bundled C client to install from.
|
||||
final List<String> bundledClientCandidates;
|
||||
|
||||
/// Directory the C client is installed into (created if absent).
|
||||
final String installDir;
|
||||
|
||||
/// First bundled C client candidate that exists, or null.
|
||||
String? findBundledClient() {
|
||||
for (final c in bundledClientCandidates) {
|
||||
if (c.isNotEmpty && File(c).existsSync()) return c;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
/// Inspect the current state of `clide` on PATH. Filesystem-only — never
|
||||
/// execs the binary, since exec'ing a stale GUI symlink is exactly the bug
|
||||
/// this guards against (it would launch a second app).
|
||||
CliInstallStatus inspect() {
|
||||
final found = _findOnPath('clide');
|
||||
if (found == null) return const CliInstallStatus(CliInstallState.missing);
|
||||
final resolved = _resolve(found);
|
||||
if (_isGui(resolved)) {
|
||||
return CliInstallStatus(CliInstallState.staleGui, pathEntry: found, resolvedTarget: resolved);
|
||||
}
|
||||
return CliInstallStatus(CliInstallState.installed, pathEntry: found, resolvedTarget: resolved);
|
||||
}
|
||||
|
||||
/// Copy the bundled C client to `<installDir>/clide` (overwriting any stale
|
||||
/// entry) and mark it executable.
|
||||
CliInstallResult install() {
|
||||
final src = findBundledClient();
|
||||
if (src == null) {
|
||||
return const CliInstallResult(
|
||||
ok: false,
|
||||
message: 'No bundled clide client found to install. Build with '
|
||||
'`make build` so the C client ships inside the app bundle.',
|
||||
);
|
||||
}
|
||||
final dest = '${_normalize(installDir)}/clide';
|
||||
try {
|
||||
Directory(installDir).createSync(recursive: true);
|
||||
// Delete any existing entry first so a stale symlink (e.g. one into
|
||||
// the GUI bundle) is replaced, not followed. typeSync never throws —
|
||||
// a missing path reports notFound.
|
||||
if (FileSystemEntity.typeSync(dest, followLinks: false) != FileSystemEntityType.notFound) {
|
||||
File(dest).deleteSync();
|
||||
}
|
||||
File(src).copySync(dest);
|
||||
_chmodExec(dest);
|
||||
} on FileSystemException catch (e) {
|
||||
return CliInstallResult(ok: false, message: 'Install failed: ${e.message}', installedPath: dest);
|
||||
}
|
||||
final onPath = _dirOnPath(installDir);
|
||||
return CliInstallResult(
|
||||
ok: true,
|
||||
installedPath: dest,
|
||||
onPath: onPath,
|
||||
message: onPath ? 'Installed clide to $dest' : 'Installed clide to $dest — add $installDir to your PATH to use it.',
|
||||
);
|
||||
}
|
||||
|
||||
/// True when [path] is, or sits inside, the Flutter GUI bundle. The C
|
||||
/// client is a standalone binary; the GUI runner ships alongside Flutter's
|
||||
/// asset payload (`data/flutter_assets`) or inside a macOS `.app`.
|
||||
bool _isGui(String path) {
|
||||
if (path == _resolve(resolvedExecutable)) return true;
|
||||
final dir = File(path).parent.path;
|
||||
if (Directory('$dir/data/flutter_assets').existsSync()) return true;
|
||||
if (path.contains('.app/Contents/')) return true;
|
||||
return false;
|
||||
}
|
||||
|
||||
String _resolve(String path) {
|
||||
try {
|
||||
return File(path).resolveSymbolicLinksSync();
|
||||
} on FileSystemException {
|
||||
return path;
|
||||
}
|
||||
}
|
||||
|
||||
void _chmodExec(String path) {
|
||||
if (Platform.isWindows) return;
|
||||
// dart:io has no chmod; copySync drops the source's +x under umask.
|
||||
Process.runSync('chmod', ['755', path]);
|
||||
}
|
||||
|
||||
bool _dirOnPath(String dir) {
|
||||
final norm = _normalize(dir);
|
||||
return _expandedPath().split(':').any((d) => d.isNotEmpty && _normalize(d) == norm);
|
||||
}
|
||||
|
||||
String _normalize(String p) => p.length > 1 && p.endsWith('/') ? p.substring(0, p.length - 1) : p;
|
||||
|
||||
String? _findOnPath(String name) {
|
||||
for (final dir in _expandedPath().split(':')) {
|
||||
if (dir.isEmpty) continue;
|
||||
final f = File('$dir/$name');
|
||||
if (f.existsSync()) return f.path;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
String _expandedPath() => expandedPath(
|
||||
env['PATH'] ?? '',
|
||||
macOS: Platform.isMacOS,
|
||||
home: env['HOME'] ?? '',
|
||||
);
|
||||
|
||||
static String _defaultInstallDir(Map<String, String> env) => '${env['HOME'] ?? ''}/.local/bin';
|
||||
|
||||
/// Where to find the C client to install from: a `CLIDE_CLI_BIN` dev
|
||||
/// override first, then `<exe-dir>/clide-cli` — where `make build` drops it
|
||||
/// inside the bundle (next to the GUI runner on Linux, in
|
||||
/// `Contents/MacOS/` on macOS).
|
||||
static List<String> _defaultBundledCandidates(String resolvedExecutable, Map<String, String> env) {
|
||||
final exeDir = File(resolvedExecutable).parent.path;
|
||||
return [
|
||||
if ((env['CLIDE_CLI_BIN'] ?? '').isNotEmpty) env['CLIDE_CLI_BIN']!,
|
||||
'$exeDir/clide-cli',
|
||||
];
|
||||
}
|
||||
}
|
||||
|
||||
/// Expand a `PATH` value. Mirrors `toolchain_paths.dart`: macOS GUI apps
|
||||
/// launch with a sparse PATH that omits the usual user/homebrew bins, so on
|
||||
/// macOS we prepend those (de-duplicated) before scanning. A top-level,
|
||||
/// platform-parameterized function so both branches are testable off-platform.
|
||||
String expandedPath(String base, {required bool macOS, String home = ''}) {
|
||||
if (!macOS) return base;
|
||||
final extras = <String>[
|
||||
if (home.isNotEmpty) '$home/.local/bin',
|
||||
'/opt/homebrew/bin',
|
||||
'/opt/homebrew/sbin',
|
||||
'/usr/local/bin',
|
||||
];
|
||||
final existing = base.split(':').toSet();
|
||||
final missing = extras.where((p) => !existing.contains(p));
|
||||
if (missing.isEmpty) return base;
|
||||
return [...missing, ...existing].join(':');
|
||||
}
|
||||
+3
-1
@@ -5,6 +5,7 @@ import 'package:clide/test_app.dart';
|
||||
import 'package:clide/builtin/canvas/canvas.dart';
|
||||
import 'package:clide/builtin/claude/claude.dart';
|
||||
import 'package:clide/builtin/claude_control/claude_control.dart';
|
||||
import 'package:clide/builtin/cli_install/cli_install.dart';
|
||||
import 'package:clide/builtin/decisions/decisions.dart';
|
||||
import 'package:clide/builtin/default_layout/default_layout.dart';
|
||||
import 'package:clide/builtin/diff/diff.dart';
|
||||
@@ -375,7 +376,8 @@ Future<void> main() async {
|
||||
..register(SettingsUiExtension())
|
||||
..register(ExtensionsUiExtension())
|
||||
..register(KeybindingsUiExtension())
|
||||
..register(ClaudeControlExtension());
|
||||
..register(ClaudeControlExtension())
|
||||
..register(CliInstallExtension());
|
||||
|
||||
await services.extensions.activateAll();
|
||||
|
||||
|
||||
Reference in New Issue
Block a user