feat(setup-wizard): improve setup wizard UX and Docker conflict handling#1232

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
msukkari merged 3 commits into from
May 28, 2026
Merged

feat(setup-wizard): improve setup wizard UX and Docker conflict handling #1232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d4e63ca
feat(setup-wizard): improve setup wizard UX and add Docker conflict h…
msukkari May 27, 2026
1191d69
docs: add CHANGELOG entry for #1232
msukkari May 27, 2026
4593f99
chore(setup-wizard): bump version to 0.1.4
msukkari May 27, 2026
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed
- Redesigned the app layout with a new collapsible sidebar navigation, replacing the previous top navigation bar. [#1097](https://github.com/sourcebot-dev/sourcebot/pull/1097)
- Expired offline license keys no longer crash the process. An expired key now degrades to the unlicensed state. [#1109](https://github.com/sourcebot-dev/sourcebot/pull/1109)
- Improved the `setup-sourcebot` wizard: prompts for a setup directory, clarifies that secrets are stored locally in `.env`, switches multi-select to Tab, hides "No results" until a real search runs, and detects/cleans up conflicting Docker deployments and volumes before starting. [#1232](https://github.com/sourcebot-dev/sourcebot/pull/1232)

## [4.17.2] - 2026-05-16

Expand Down
2 changes: 1 addition & 1 deletion packages/setupWizard/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
"name": "setup-sourcebot",
"version": "0.1.3",
"version": "0.1.4",
"description": "CLI wizard for creating a Sourcebot configuration.",
"type": "module",
"bin": "./dist/index.js",
Expand Down
5 changes: 3 additions & 2 deletions packages/setupWizard/src/azuredevops.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { checkbox, confirm, input, password, select } from '@inquirer/prompts';
import { confirm, input, password, select } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { AzureDevOpsConnectionConfig } from '@sourcebot/schemas/v3/azuredevops.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, note, toEnvKey } from './utils.js';
Expand DownExpand Up@@ -57,7 +58,7 @@ export async function collectAzureDevOpsConfig(connectionName: string): Promise<

const envKey = toEnvKey(connectionName, 'TOKEN');
const token = await password({
message: `Azure DevOps Personal Access Token (stored as ${envKey})`,
message: `Azure DevOps Personal Access Token (stored locally in .env as ${envKey})`,
mask: true,
validate: (v) => !v?.trim() ? 'Token is required' : true,
});
Expand Down
11 changes: 6 additions & 5 deletions packages/setupWizard/src/bitbucket.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { checkbox, confirm, input, password, select } from '@inquirer/prompts';
import { confirm, input, password, select } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { BitbucketConnectionConfig } from '@sourcebot/schemas/v3/bitbucket.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, note, toEnvKey } from './utils.js';
Expand DownExpand Up@@ -78,7 +79,7 @@ async function collectBitbucketCloud(

const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
const token = await password({
message: `API Token (stored as ${tokenEnvKey})`,
message: `API Token (stored locally in .env as ${tokenEnvKey})`,
mask: true,
validate: (v) => !v?.trim() ? 'Token is required' : true,
});
Expand All@@ -95,7 +96,7 @@ async function collectBitbucketCloud(

const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
const token = await password({
message: `Access Token (stored as ${tokenEnvKey})`,
message: `Access Token (stored locally in .env as ${tokenEnvKey})`,
mask: true,
validate: (v) => !v?.trim() ? 'Token is required' : true,
});
Expand All@@ -121,7 +122,7 @@ async function collectBitbucketCloud(

const tokenEnvKey = toEnvKey(connectionName, 'APP_PASSWORD');
const token = await password({
message: `Bitbucket App Password (stored as ${tokenEnvKey})`,
message: `Bitbucket App Password (stored locally in .env as ${tokenEnvKey})`,
mask: true,
validate: (v) => !v?.trim() ? 'App Password is required' : true,
});
Expand DownExpand Up@@ -193,7 +194,7 @@ async function collectBitbucketServer(

const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
const token = await password({
message: `Bitbucket HTTP Access Token (stored as ${tokenEnvKey})`,
message: `Bitbucket HTTP Access Token (stored locally in .env as ${tokenEnvKey})`,
mask: true,
validate: (v) => !v?.trim() ? 'Token is required' : true,
});
Expand Down
8 changes: 5 additions & 3 deletions packages/setupWizard/src/gitea.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { GiteaConnectionConfig } from '@sourcebot/schemas/v3/gitea.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, toEnvKey } from './utils.js';
import { INPUT_THEME, multiInput, toEnvKey } from './utils.js';

export async function collectGiteaConfig(connectionName: string): Promise<CollectResult> {
const env: EnvVars = {};
Expand All@@ -10,6 +11,7 @@ export async function collectGiteaConfig(connectionName: string): Promise<Collec
const url = await input({
message: 'Gitea URL',
default: 'https://gitea.com',
theme: INPUT_THEME,
validate: (v) => {
if (!v?.trim()) {
return 'URL is required';
Expand All@@ -26,7 +28,7 @@ export async function collectGiteaConfig(connectionName: string): Promise<Collec

const giteaEnvKey = toEnvKey(connectionName, 'TOKEN');
const giteaToken = await password({
message: `Gitea Access Token (stored as ${giteaEnvKey}, leave blank for public repos only)`,
message: `Gitea Access Token (stored locally in .env as ${giteaEnvKey}, leave blank for public repos only)`,
mask: true,
});
if (giteaToken.trim()) {
Expand Down
50 changes: 38 additions & 12 deletions packages/setupWizard/src/github.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import { select as searchSelect, Separator } from 'inquirer-select-pro';
import type { GithubConnectionConfig } from '@sourcebot/schemas/v3/github.type';
import type { CollectResult, EnvVars } from './utils.js';
import { note, toEnvKey } from './utils.js';
import { createSearchSelectContext, INPUT_THEME, note, toEnvKey } from './utils.js';

function githubApiBase(url: string): string {
try {
Expand DownExpand Up@@ -75,6 +76,7 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
const url = await input({
message: 'GitHub URL',
default: 'https://github.com',
theme: INPUT_THEME,
validate: (v) => {
if (!v?.trim()) {
return 'URL is required';
Expand DownExpand Up@@ -104,7 +106,7 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle

const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
const token = await password({
message: `GitHub Personal Access Token (stored as ${tokenEnvKey}, leave blank for public repos only)`,
message: `GitHub Personal Access Token (stored locally in .env as ${tokenEnvKey}, leave blank for public repos only)`,
mask: true,
});
if (token.trim()) {
Expand All@@ -125,18 +127,26 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
});

if (targets.includes('repos')) {
const ctx = createSearchSelectContext();
const repos = await searchSelect<string, true>({
message: 'Repositories to index (type to search, or type owner/repo)',
multiple: true,
required: true,
loop: false,
clearInputWhenSelected: true,
placeholder: 'Type 2+ characters to search...',
theme: ctx.theme,
placeholder: 'Type to search...',
options: async (search) => {
if (!search || search.length < 2) {
ctx.trackSearch(search);
if (!search) {
return [];
}
return searchGitHub(apiBase, search, token, 'repo');
ctx.setLoading(true);
try {
return await searchGitHub(apiBase, search, token, 'repo');
} finally {
ctx.setLoading(false);
}
},
validate: (selected) => {
for (const opt of selected) {
Expand All@@ -151,36 +161,52 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
}

if (targets.includes('orgs')) {
const ctx = createSearchSelectContext();
const orgs = await searchSelect<string, true>({
message: 'Organizations to index (type to search)',
multiple: true,
required: true,
loop: false,
clearInputWhenSelected: true,
placeholder: 'Type 2+ characters to search...',
theme: ctx.theme,
placeholder: 'Type to search...',
options: async (search) => {
if (!search || search.length < 2) {
ctx.trackSearch(search);
if (!search) {
return [];
}
return searchGitHub(apiBase, search, token, 'org');
ctx.setLoading(true);
try {
return await searchGitHub(apiBase, search, token, 'org');
} finally {
ctx.setLoading(false);
}
},
});
config.orgs = orgs;
}

if (targets.includes('users')) {
const ctx = createSearchSelectContext();
const users = await searchSelect<string, true>({
message: 'GitHub users to index (type to search)',
multiple: true,
required: true,
loop: false,
clearInputWhenSelected: true,
placeholder: 'Type 2+ characters to search...',
theme: ctx.theme,
placeholder: 'Type to search...',
options: async (search) => {
if (!search || search.length < 2) {
ctx.trackSearch(search);
if (!search) {
return [];
}
return searchGitHub(apiBase, search, token, 'user');
ctx.setLoading(true);
try {
return await searchGitHub(apiBase, search, token, 'user');
} finally {
ctx.setLoading(false);
}
},
});
config.users = users;
Expand Down
50 changes: 38 additions & 12 deletions packages/setupWizard/src/gitlab.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import { select as searchSelect, Separator } from 'inquirer-select-pro';
import type { GitlabConnectionConfig } from '@sourcebot/schemas/v3/gitlab.type';
import type { CollectResult, EnvVars } from './utils.js';
import { note, toEnvKey } from './utils.js';
import { createSearchSelectContext, INPUT_THEME, note, toEnvKey } from './utils.js';

function gitlabApiBase(url: string): string {
try {
Expand DownExpand Up@@ -89,6 +90,7 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
const url = await input({
message: 'GitLab URL',
default: 'https://gitlab.com',
theme: INPUT_THEME,
validate: (v) => {
if (!v?.trim()) {
return 'URL is required';
Expand All@@ -114,7 +116,7 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle

const gitlabEnvKey = toEnvKey(connectionName, 'TOKEN');
const gitlabToken = await password({
message: `GitLab Personal Access Token (stored as ${gitlabEnvKey}, leave blank for public repos only)`,
message: `GitLab Personal Access Token (stored locally in .env as ${gitlabEnvKey}, leave blank for public repos only)`,
mask: true,
});
if (gitlabToken.trim()) {
Expand DownExpand Up@@ -143,36 +145,52 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
}

if (targets.includes('groups')) {
const ctx = createSearchSelectContext();
const groups = await searchSelect<string, true>({
message: 'Groups to index (type to search)',
multiple: true,
required: true,
loop: false,
clearInputWhenSelected: true,
placeholder: 'Type 2+ characters to search...',
theme: ctx.theme,
placeholder: 'Type to search...',
options: async (search) => {
if (!search || search.length < 2) {
ctx.trackSearch(search);
if (!search) {
return [];
}
return searchGitLab(apiBase, search, gitlabToken, 'group');
ctx.setLoading(true);
try {
return await searchGitLab(apiBase, search, gitlabToken, 'group');
} finally {
ctx.setLoading(false);
}
},
});
config.groups = groups;
}

if (targets.includes('projects')) {
const ctx = createSearchSelectContext();
const projects = await searchSelect<string, true>({
message: 'Projects to index (type to search, or type group/project)',
multiple: true,
required: true,
loop: false,
clearInputWhenSelected: true,
placeholder: 'Type 2+ characters to search...',
theme: ctx.theme,
placeholder: 'Type to search...',
options: async (search) => {
if (!search || search.length < 2) {
ctx.trackSearch(search);
if (!search) {
return [];
}
return searchGitLab(apiBase, search, gitlabToken, 'project');
ctx.setLoading(true);
try {
return await searchGitLab(apiBase, search, gitlabToken, 'project');
} finally {
ctx.setLoading(false);
}
},
validate: (selected) => {
for (const opt of selected) {
Expand All@@ -187,18 +205,26 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
}

if (targets.includes('users')) {
const ctx = createSearchSelectContext();
const users = await searchSelect<string, true>({
message: 'Users to index (type to search)',
multiple: true,
required: true,
loop: false,
clearInputWhenSelected: true,
placeholder: 'Type 2+ characters to search...',
theme: ctx.theme,
placeholder: 'Type to search...',
options: async (search) => {
if (!search || search.length < 2) {
ctx.trackSearch(search);
if (!search) {
return [];
}
return searchGitLab(apiBase, search, gitlabToken, 'user');
ctx.setLoading(true);
try {
return await searchGitLab(apiBase, search, gitlabToken, 'user');
} finally {
ctx.setLoading(false);
}
},
});
config.users = users;
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
feat(setup-wizard): improve setup wizard UX and Docker conflict handling#1232

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

msukkari
merged 3 commits into

from

May 28, 2026
 Merged


feat(setup-wizard): improve setup wizard UX and Docker conflict handling
#1232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
d4e63ca

feat(setup-wizard): improve setup wizard UX and add Docker conflict h…


msukkari May 27, 2026
1191d69

docs: add CHANGELOG entry for #1232


msukkari May 27, 2026
4593f99

chore(setup-wizard): bump version to 0.1.4


msukkari May 27, 2026

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed
- Redesigned the app layout with a new collapsible sidebar navigation, replacing the previous top navigation bar. [#1097](https://github.com/sourcebot-dev/sourcebot/pull/1097)
- Expired offline license keys no longer crash the process. An expired key now degrades to the unlicensed state. [#1109](https://github.com/sourcebot-dev/sourcebot/pull/1109)
- Improved the `setup-sourcebot` wizard: prompts for a setup directory, clarifies that secrets are stored locally in `.env`, switches multi-select to Tab, hides "No results" until a real search runs, and detects/cleans up conflicting Docker deployments and volumes before starting. [#1232](https://github.com/sourcebot-dev/sourcebot/pull/1232)

## [4.17.2] - 2026-05-16

Expand Down

2 changes: 1 addition & 1 deletion
packages/setupWizard/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
 "name": "setup-sourcebot",
 "version": "0.1.3",
 "version": "0.1.4",
 "description": "CLI wizard for creating a Sourcebot configuration.",
 "type": "module",
 "bin": "./dist/index.js",
Expand Down

5 changes: 3 additions & 2 deletions
packages/setupWizard/src/azuredevops.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { checkbox, confirm, input, password, select } from '@inquirer/prompts';
import { confirm, input, password, select } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { AzureDevOpsConnectionConfig } from '@sourcebot/schemas/v3/azuredevops.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, note, toEnvKey } from './utils.js';
Expand DownExpand Up@@ -57,7 +58,7 @@ export async function collectAzureDevOpsConfig(connectionName: string): Promise<

 const envKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Azure DevOps Personal Access Token (stored as ${envKey})`,
 message: `Azure DevOps Personal Access Token (stored locally in .env as ${envKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand Down

11 changes: 6 additions & 5 deletions
packages/setupWizard/src/bitbucket.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { checkbox, confirm, input, password, select } from '@inquirer/prompts';
import { confirm, input, password, select } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { BitbucketConnectionConfig } from '@sourcebot/schemas/v3/bitbucket.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, note, toEnvKey } from './utils.js';
Expand DownExpand Up@@ -78,7 +79,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `API Token (stored as ${tokenEnvKey})`,
 message: `API Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand All@@ -95,7 +96,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Access Token (stored as ${tokenEnvKey})`,
 message: `Access Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand All@@ -121,7 +122,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'APP_PASSWORD');
 const token = await password({
 message: `Bitbucket App Password (stored as ${tokenEnvKey})`,
 message: `Bitbucket App Password (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'App Password is required' : true,
 });
Expand DownExpand Up@@ -193,7 +194,7 @@ async function collectBitbucketServer(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Bitbucket HTTP Access Token (stored as ${tokenEnvKey})`,
 message: `Bitbucket HTTP Access Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand Down

8 changes: 5 additions & 3 deletions
packages/setupWizard/src/gitea.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { GiteaConnectionConfig } from '@sourcebot/schemas/v3/gitea.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, toEnvKey } from './utils.js';
import { INPUT_THEME, multiInput, toEnvKey } from './utils.js';

export async function collectGiteaConfig(connectionName: string): Promise<CollectResult> {
 const env: EnvVars = {};
Expand All@@ -10,6 +11,7 @@ export async function collectGiteaConfig(connectionName: string): Promise<Collec
 const url = await input({
 message: 'Gitea URL',
 default: 'https://gitea.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand All@@ -26,7 +28,7 @@ export async function collectGiteaConfig(connectionName: string): Promise<Collec

 const giteaEnvKey = toEnvKey(connectionName, 'TOKEN');
 const giteaToken = await password({
 message: `Gitea Access Token (stored as ${giteaEnvKey}, leave blank for public repos only)`,
 message: `Gitea Access Token (stored locally in .env as ${giteaEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (giteaToken.trim()) {
Expand Down

50 changes: 38 additions & 12 deletions
packages/setupWizard/src/github.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import { select as searchSelect, Separator } from 'inquirer-select-pro';
import type { GithubConnectionConfig } from '@sourcebot/schemas/v3/github.type';
import type { CollectResult, EnvVars } from './utils.js';
import { note, toEnvKey } from './utils.js';
import { createSearchSelectContext, INPUT_THEME, note, toEnvKey } from './utils.js';

function githubApiBase(url: string): string {
 try {
Expand DownExpand Up@@ -75,6 +76,7 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 const url = await input({
 message: 'GitHub URL',
 default: 'https://github.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand DownExpand Up@@ -104,7 +106,7 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `GitHub Personal Access Token (stored as ${tokenEnvKey}, leave blank for public repos only)`,
 message: `GitHub Personal Access Token (stored locally in .env as ${tokenEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (token.trim()) {
Expand All@@ -125,18 +127,26 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 });

 if (targets.includes('repos')) {
 const ctx = createSearchSelectContext();
 const repos = await searchSelect<string, true>({
 message: 'Repositories to index (type to search, or type owner/repo)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'repo');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'repo');
 } finally {
 ctx.setLoading(false);
 }
 },
 validate: (selected) => {
 for (const opt of selected) {
Expand All@@ -151,36 +161,52 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('orgs')) {
 const ctx = createSearchSelectContext();
 const orgs = await searchSelect<string, true>({
 message: 'Organizations to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'org');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'org');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.orgs = orgs;
 }

 if (targets.includes('users')) {
 const ctx = createSearchSelectContext();
 const users = await searchSelect<string, true>({
 message: 'GitHub users to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'user');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'user');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.users = users;
Expand Down

50 changes: 38 additions & 12 deletions
packages/setupWizard/src/gitlab.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import { select as searchSelect, Separator } from 'inquirer-select-pro';
import type { GitlabConnectionConfig } from '@sourcebot/schemas/v3/gitlab.type';
import type { CollectResult, EnvVars } from './utils.js';
import { note, toEnvKey } from './utils.js';
import { createSearchSelectContext, INPUT_THEME, note, toEnvKey } from './utils.js';

function gitlabApiBase(url: string): string {
 try {
Expand DownExpand Up@@ -89,6 +90,7 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 const url = await input({
 message: 'GitLab URL',
 default: 'https://gitlab.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand All@@ -114,7 +116,7 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle

 const gitlabEnvKey = toEnvKey(connectionName, 'TOKEN');
 const gitlabToken = await password({
 message: `GitLab Personal Access Token (stored as ${gitlabEnvKey}, leave blank for public repos only)`,
 message: `GitLab Personal Access Token (stored locally in .env as ${gitlabEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (gitlabToken.trim()) {
Expand DownExpand Up@@ -143,36 +145,52 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('groups')) {
 const ctx = createSearchSelectContext();
 const groups = await searchSelect<string, true>({
 message: 'Groups to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'group');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'group');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.groups = groups;
 }

 if (targets.includes('projects')) {
 const ctx = createSearchSelectContext();
 const projects = await searchSelect<string, true>({
 message: 'Projects to index (type to search, or type group/project)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'project');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'project');
 } finally {
 ctx.setLoading(false);
 }
 },
 validate: (selected) => {
 for (const opt of selected) {
Expand All@@ -187,18 +205,26 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('users')) {
 const ctx = createSearchSelectContext();
 const users = await searchSelect<string, true>({
 message: 'Users to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'user');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'user');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.users = users;
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(setup-wizard): improve setup wizard UX and Docker conflict handling#1232

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

msukkari
merged 3 commits into

from

May 28, 2026
 Merged


feat(setup-wizard): improve setup wizard UX and Docker conflict handling
#1232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
d4e63ca

feat(setup-wizard): improve setup wizard UX and add Docker conflict h…


msukkari May 27, 2026
1191d69

docs: add CHANGELOG entry for #1232


msukkari May 27, 2026
4593f99

chore(setup-wizard): bump version to 0.1.4


msukkari May 27, 2026

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed
- Redesigned the app layout with a new collapsible sidebar navigation, replacing the previous top navigation bar. [#1097](https://github.com/sourcebot-dev/sourcebot/pull/1097)
- Expired offline license keys no longer crash the process. An expired key now degrades to the unlicensed state. [#1109](https://github.com/sourcebot-dev/sourcebot/pull/1109)
- Improved the `setup-sourcebot` wizard: prompts for a setup directory, clarifies that secrets are stored locally in `.env`, switches multi-select to Tab, hides "No results" until a real search runs, and detects/cleans up conflicting Docker deployments and volumes before starting. [#1232](https://github.com/sourcebot-dev/sourcebot/pull/1232)

## [4.17.2] - 2026-05-16

Expand Down

2 changes: 1 addition & 1 deletion
packages/setupWizard/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
 "name": "setup-sourcebot",
 "version": "0.1.3",
 "version": "0.1.4",
 "description": "CLI wizard for creating a Sourcebot configuration.",
 "type": "module",
 "bin": "./dist/index.js",
Expand Down

5 changes: 3 additions & 2 deletions
packages/setupWizard/src/azuredevops.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { checkbox, confirm, input, password, select } from '@inquirer/prompts';
import { confirm, input, password, select } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { AzureDevOpsConnectionConfig } from '@sourcebot/schemas/v3/azuredevops.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, note, toEnvKey } from './utils.js';
Expand DownExpand Up@@ -57,7 +58,7 @@ export async function collectAzureDevOpsConfig(connectionName: string): Promise<

 const envKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Azure DevOps Personal Access Token (stored as ${envKey})`,
 message: `Azure DevOps Personal Access Token (stored locally in .env as ${envKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand Down

11 changes: 6 additions & 5 deletions
packages/setupWizard/src/bitbucket.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { checkbox, confirm, input, password, select } from '@inquirer/prompts';
import { confirm, input, password, select } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { BitbucketConnectionConfig } from '@sourcebot/schemas/v3/bitbucket.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, note, toEnvKey } from './utils.js';
Expand DownExpand Up@@ -78,7 +79,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `API Token (stored as ${tokenEnvKey})`,
 message: `API Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand All@@ -95,7 +96,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Access Token (stored as ${tokenEnvKey})`,
 message: `Access Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand All@@ -121,7 +122,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'APP_PASSWORD');
 const token = await password({
 message: `Bitbucket App Password (stored as ${tokenEnvKey})`,
 message: `Bitbucket App Password (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'App Password is required' : true,
 });
Expand DownExpand Up@@ -193,7 +194,7 @@ async function collectBitbucketServer(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Bitbucket HTTP Access Token (stored as ${tokenEnvKey})`,
 message: `Bitbucket HTTP Access Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand Down

8 changes: 5 additions & 3 deletions
packages/setupWizard/src/gitea.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { GiteaConnectionConfig } from '@sourcebot/schemas/v3/gitea.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, toEnvKey } from './utils.js';
import { INPUT_THEME, multiInput, toEnvKey } from './utils.js';

export async function collectGiteaConfig(connectionName: string): Promise<CollectResult> {
 const env: EnvVars = {};
Expand All@@ -10,6 +11,7 @@ export async function collectGiteaConfig(connectionName: string): Promise<Collec
 const url = await input({
 message: 'Gitea URL',
 default: 'https://gitea.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand All@@ -26,7 +28,7 @@ export async function collectGiteaConfig(connectionName: string): Promise<Collec

 const giteaEnvKey = toEnvKey(connectionName, 'TOKEN');
 const giteaToken = await password({
 message: `Gitea Access Token (stored as ${giteaEnvKey}, leave blank for public repos only)`,
 message: `Gitea Access Token (stored locally in .env as ${giteaEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (giteaToken.trim()) {
Expand Down

50 changes: 38 additions & 12 deletions
packages/setupWizard/src/github.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import { select as searchSelect, Separator } from 'inquirer-select-pro';
import type { GithubConnectionConfig } from '@sourcebot/schemas/v3/github.type';
import type { CollectResult, EnvVars } from './utils.js';
import { note, toEnvKey } from './utils.js';
import { createSearchSelectContext, INPUT_THEME, note, toEnvKey } from './utils.js';

function githubApiBase(url: string): string {
 try {
Expand DownExpand Up@@ -75,6 +76,7 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 const url = await input({
 message: 'GitHub URL',
 default: 'https://github.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand DownExpand Up@@ -104,7 +106,7 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `GitHub Personal Access Token (stored as ${tokenEnvKey}, leave blank for public repos only)`,
 message: `GitHub Personal Access Token (stored locally in .env as ${tokenEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (token.trim()) {
Expand All@@ -125,18 +127,26 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 });

 if (targets.includes('repos')) {
 const ctx = createSearchSelectContext();
 const repos = await searchSelect<string, true>({
 message: 'Repositories to index (type to search, or type owner/repo)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'repo');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'repo');
 } finally {
 ctx.setLoading(false);
 }
 },
 validate: (selected) => {
 for (const opt of selected) {
Expand All@@ -151,36 +161,52 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('orgs')) {
 const ctx = createSearchSelectContext();
 const orgs = await searchSelect<string, true>({
 message: 'Organizations to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'org');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'org');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.orgs = orgs;
 }

 if (targets.includes('users')) {
 const ctx = createSearchSelectContext();
 const users = await searchSelect<string, true>({
 message: 'GitHub users to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'user');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'user');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.users = users;
Expand Down

50 changes: 38 additions & 12 deletions
packages/setupWizard/src/gitlab.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import { select as searchSelect, Separator } from 'inquirer-select-pro';
import type { GitlabConnectionConfig } from '@sourcebot/schemas/v3/gitlab.type';
import type { CollectResult, EnvVars } from './utils.js';
import { note, toEnvKey } from './utils.js';
import { createSearchSelectContext, INPUT_THEME, note, toEnvKey } from './utils.js';

function gitlabApiBase(url: string): string {
 try {
Expand DownExpand Up@@ -89,6 +90,7 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 const url = await input({
 message: 'GitLab URL',
 default: 'https://gitlab.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand All@@ -114,7 +116,7 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle

 const gitlabEnvKey = toEnvKey(connectionName, 'TOKEN');
 const gitlabToken = await password({
 message: `GitLab Personal Access Token (stored as ${gitlabEnvKey}, leave blank for public repos only)`,
 message: `GitLab Personal Access Token (stored locally in .env as ${gitlabEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (gitlabToken.trim()) {
Expand DownExpand Up@@ -143,36 +145,52 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('groups')) {
 const ctx = createSearchSelectContext();
 const groups = await searchSelect<string, true>({
 message: 'Groups to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'group');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'group');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.groups = groups;
 }

 if (targets.includes('projects')) {
 const ctx = createSearchSelectContext();
 const projects = await searchSelect<string, true>({
 message: 'Projects to index (type to search, or type group/project)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'project');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'project');
 } finally {
 ctx.setLoading(false);
 }
 },
 validate: (selected) => {
 for (const opt of selected) {
Expand All@@ -187,18 +205,26 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('users')) {
 const ctx = createSearchSelectContext();
 const users = await searchSelect<string, true>({
 message: 'Users to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'user');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'user');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.users = users;
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(setup-wizard): improve setup wizard UX and Docker conflict handling#1232

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

msukkari
merged 3 commits into

from

May 28, 2026
 Merged


feat(setup-wizard): improve setup wizard UX and Docker conflict handling
#1232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
d4e63ca

feat(setup-wizard): improve setup wizard UX and add Docker conflict h…


msukkari May 27, 2026
1191d69

docs: add CHANGELOG entry for #1232


msukkari May 27, 2026
4593f99

chore(setup-wizard): bump version to 0.1.4


msukkari May 27, 2026

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed
- Redesigned the app layout with a new collapsible sidebar navigation, replacing the previous top navigation bar. [#1097](https://github.com/sourcebot-dev/sourcebot/pull/1097)
- Expired offline license keys no longer crash the process. An expired key now degrades to the unlicensed state. [#1109](https://github.com/sourcebot-dev/sourcebot/pull/1109)
- Improved the `setup-sourcebot` wizard: prompts for a setup directory, clarifies that secrets are stored locally in `.env`, switches multi-select to Tab, hides "No results" until a real search runs, and detects/cleans up conflicting Docker deployments and volumes before starting. [#1232](https://github.com/sourcebot-dev/sourcebot/pull/1232)

## [4.17.2] - 2026-05-16

Expand Down

2 changes: 1 addition & 1 deletion
packages/setupWizard/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
 "name": "setup-sourcebot",
 "version": "0.1.3",
 "version": "0.1.4",
 "description": "CLI wizard for creating a Sourcebot configuration.",
 "type": "module",
 "bin": "./dist/index.js",
Expand Down

5 changes: 3 additions & 2 deletions
packages/setupWizard/src/azuredevops.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { checkbox, confirm, input, password, select } from '@inquirer/prompts';
import { confirm, input, password, select } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { AzureDevOpsConnectionConfig } from '@sourcebot/schemas/v3/azuredevops.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, note, toEnvKey } from './utils.js';
Expand DownExpand Up@@ -57,7 +58,7 @@ export async function collectAzureDevOpsConfig(connectionName: string): Promise<

 const envKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Azure DevOps Personal Access Token (stored as ${envKey})`,
 message: `Azure DevOps Personal Access Token (stored locally in .env as ${envKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand Down

11 changes: 6 additions & 5 deletions
packages/setupWizard/src/bitbucket.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { checkbox, confirm, input, password, select } from '@inquirer/prompts';
import { confirm, input, password, select } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { BitbucketConnectionConfig } from '@sourcebot/schemas/v3/bitbucket.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, note, toEnvKey } from './utils.js';
Expand DownExpand Up@@ -78,7 +79,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `API Token (stored as ${tokenEnvKey})`,
 message: `API Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand All@@ -95,7 +96,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Access Token (stored as ${tokenEnvKey})`,
 message: `Access Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand All@@ -121,7 +122,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'APP_PASSWORD');
 const token = await password({
 message: `Bitbucket App Password (stored as ${tokenEnvKey})`,
 message: `Bitbucket App Password (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'App Password is required' : true,
 });
Expand DownExpand Up@@ -193,7 +194,7 @@ async function collectBitbucketServer(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Bitbucket HTTP Access Token (stored as ${tokenEnvKey})`,
 message: `Bitbucket HTTP Access Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand Down

8 changes: 5 additions & 3 deletions
packages/setupWizard/src/gitea.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { GiteaConnectionConfig } from '@sourcebot/schemas/v3/gitea.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, toEnvKey } from './utils.js';
import { INPUT_THEME, multiInput, toEnvKey } from './utils.js';

export async function collectGiteaConfig(connectionName: string): Promise<CollectResult> {
 const env: EnvVars = {};
Expand All@@ -10,6 +11,7 @@ export async function collectGiteaConfig(connectionName: string): Promise<Collec
 const url = await input({
 message: 'Gitea URL',
 default: 'https://gitea.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand All@@ -26,7 +28,7 @@ export async function collectGiteaConfig(connectionName: string): Promise<Collec

 const giteaEnvKey = toEnvKey(connectionName, 'TOKEN');
 const giteaToken = await password({
 message: `Gitea Access Token (stored as ${giteaEnvKey}, leave blank for public repos only)`,
 message: `Gitea Access Token (stored locally in .env as ${giteaEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (giteaToken.trim()) {
Expand Down

50 changes: 38 additions & 12 deletions
packages/setupWizard/src/github.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import { select as searchSelect, Separator } from 'inquirer-select-pro';
import type { GithubConnectionConfig } from '@sourcebot/schemas/v3/github.type';
import type { CollectResult, EnvVars } from './utils.js';
import { note, toEnvKey } from './utils.js';
import { createSearchSelectContext, INPUT_THEME, note, toEnvKey } from './utils.js';

function githubApiBase(url: string): string {
 try {
Expand DownExpand Up@@ -75,6 +76,7 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 const url = await input({
 message: 'GitHub URL',
 default: 'https://github.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand DownExpand Up@@ -104,7 +106,7 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `GitHub Personal Access Token (stored as ${tokenEnvKey}, leave blank for public repos only)`,
 message: `GitHub Personal Access Token (stored locally in .env as ${tokenEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (token.trim()) {
Expand All@@ -125,18 +127,26 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 });

 if (targets.includes('repos')) {
 const ctx = createSearchSelectContext();
 const repos = await searchSelect<string, true>({
 message: 'Repositories to index (type to search, or type owner/repo)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'repo');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'repo');
 } finally {
 ctx.setLoading(false);
 }
 },
 validate: (selected) => {
 for (const opt of selected) {
Expand All@@ -151,36 +161,52 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('orgs')) {
 const ctx = createSearchSelectContext();
 const orgs = await searchSelect<string, true>({
 message: 'Organizations to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'org');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'org');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.orgs = orgs;
 }

 if (targets.includes('users')) {
 const ctx = createSearchSelectContext();
 const users = await searchSelect<string, true>({
 message: 'GitHub users to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'user');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'user');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.users = users;
Expand Down

50 changes: 38 additions & 12 deletions
packages/setupWizard/src/gitlab.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import { select as searchSelect, Separator } from 'inquirer-select-pro';
import type { GitlabConnectionConfig } from '@sourcebot/schemas/v3/gitlab.type';
import type { CollectResult, EnvVars } from './utils.js';
import { note, toEnvKey } from './utils.js';
import { createSearchSelectContext, INPUT_THEME, note, toEnvKey } from './utils.js';

function gitlabApiBase(url: string): string {
 try {
Expand DownExpand Up@@ -89,6 +90,7 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 const url = await input({
 message: 'GitLab URL',
 default: 'https://gitlab.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand All@@ -114,7 +116,7 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle

 const gitlabEnvKey = toEnvKey(connectionName, 'TOKEN');
 const gitlabToken = await password({
 message: `GitLab Personal Access Token (stored as ${gitlabEnvKey}, leave blank for public repos only)`,
 message: `GitLab Personal Access Token (stored locally in .env as ${gitlabEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (gitlabToken.trim()) {
Expand DownExpand Up@@ -143,36 +145,52 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('groups')) {
 const ctx = createSearchSelectContext();
 const groups = await searchSelect<string, true>({
 message: 'Groups to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'group');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'group');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.groups = groups;
 }

 if (targets.includes('projects')) {
 const ctx = createSearchSelectContext();
 const projects = await searchSelect<string, true>({
 message: 'Projects to index (type to search, or type group/project)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'project');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'project');
 } finally {
 ctx.setLoading(false);
 }
 },
 validate: (selected) => {
 for (const opt of selected) {
Expand All@@ -187,18 +205,26 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('users')) {
 const ctx = createSearchSelectContext();
 const users = await searchSelect<string, true>({
 message: 'Users to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'user');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'user');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.users = users;
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
feat(setup-wizard): improve setup wizard UX and Docker conflict handling#1232

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

msukkari
merged 3 commits into

from

May 28, 2026
 Merged


feat(setup-wizard): improve setup wizard UX and Docker conflict handling
#1232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
d4e63ca

feat(setup-wizard): improve setup wizard UX and add Docker conflict h…


msukkari May 27, 2026
1191d69

docs: add CHANGELOG entry for #1232


msukkari May 27, 2026
4593f99

chore(setup-wizard): bump version to 0.1.4


msukkari May 27, 2026

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed
- Redesigned the app layout with a new collapsible sidebar navigation, replacing the previous top navigation bar. [#1097](https://github.com/sourcebot-dev/sourcebot/pull/1097)
- Expired offline license keys no longer crash the process. An expired key now degrades to the unlicensed state. [#1109](https://github.com/sourcebot-dev/sourcebot/pull/1109)
- Improved the `setup-sourcebot` wizard: prompts for a setup directory, clarifies that secrets are stored locally in `.env`, switches multi-select to Tab, hides "No results" until a real search runs, and detects/cleans up conflicting Docker deployments and volumes before starting. [#1232](https://github.com/sourcebot-dev/sourcebot/pull/1232)

## [4.17.2] - 2026-05-16

Expand Down

2 changes: 1 addition & 1 deletion
packages/setupWizard/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
 "name": "setup-sourcebot",
 "version": "0.1.3",
 "version": "0.1.4",
 "description": "CLI wizard for creating a Sourcebot configuration.",
 "type": "module",
 "bin": "./dist/index.js",
Expand Down

5 changes: 3 additions & 2 deletions
packages/setupWizard/src/azuredevops.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { checkbox, confirm, input, password, select } from '@inquirer/prompts';
import { confirm, input, password, select } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { AzureDevOpsConnectionConfig } from '@sourcebot/schemas/v3/azuredevops.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, note, toEnvKey } from './utils.js';
Expand DownExpand Up@@ -57,7 +58,7 @@ export async function collectAzureDevOpsConfig(connectionName: string): Promise<

 const envKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Azure DevOps Personal Access Token (stored as ${envKey})`,
 message: `Azure DevOps Personal Access Token (stored locally in .env as ${envKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand Down

11 changes: 6 additions & 5 deletions
packages/setupWizard/src/bitbucket.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { checkbox, confirm, input, password, select } from '@inquirer/prompts';
import { confirm, input, password, select } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { BitbucketConnectionConfig } from '@sourcebot/schemas/v3/bitbucket.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, note, toEnvKey } from './utils.js';
Expand DownExpand Up@@ -78,7 +79,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `API Token (stored as ${tokenEnvKey})`,
 message: `API Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand All@@ -95,7 +96,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Access Token (stored as ${tokenEnvKey})`,
 message: `Access Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand All@@ -121,7 +122,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'APP_PASSWORD');
 const token = await password({
 message: `Bitbucket App Password (stored as ${tokenEnvKey})`,
 message: `Bitbucket App Password (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'App Password is required' : true,
 });
Expand DownExpand Up@@ -193,7 +194,7 @@ async function collectBitbucketServer(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Bitbucket HTTP Access Token (stored as ${tokenEnvKey})`,
 message: `Bitbucket HTTP Access Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand Down

8 changes: 5 additions & 3 deletions
packages/setupWizard/src/gitea.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { GiteaConnectionConfig } from '@sourcebot/schemas/v3/gitea.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, toEnvKey } from './utils.js';
import { INPUT_THEME, multiInput, toEnvKey } from './utils.js';

export async function collectGiteaConfig(connectionName: string): Promise<CollectResult> {
 const env: EnvVars = {};
Expand All@@ -10,6 +11,7 @@ export async function collectGiteaConfig(connectionName: string): Promise<Collec
 const url = await input({
 message: 'Gitea URL',
 default: 'https://gitea.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand All@@ -26,7 +28,7 @@ export async function collectGiteaConfig(connectionName: string): Promise<Collec

 const giteaEnvKey = toEnvKey(connectionName, 'TOKEN');
 const giteaToken = await password({
 message: `Gitea Access Token (stored as ${giteaEnvKey}, leave blank for public repos only)`,
 message: `Gitea Access Token (stored locally in .env as ${giteaEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (giteaToken.trim()) {
Expand Down

50 changes: 38 additions & 12 deletions
packages/setupWizard/src/github.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import { select as searchSelect, Separator } from 'inquirer-select-pro';
import type { GithubConnectionConfig } from '@sourcebot/schemas/v3/github.type';
import type { CollectResult, EnvVars } from './utils.js';
import { note, toEnvKey } from './utils.js';
import { createSearchSelectContext, INPUT_THEME, note, toEnvKey } from './utils.js';

function githubApiBase(url: string): string {
 try {
Expand DownExpand Up@@ -75,6 +76,7 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 const url = await input({
 message: 'GitHub URL',
 default: 'https://github.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand DownExpand Up@@ -104,7 +106,7 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `GitHub Personal Access Token (stored as ${tokenEnvKey}, leave blank for public repos only)`,
 message: `GitHub Personal Access Token (stored locally in .env as ${tokenEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (token.trim()) {
Expand All@@ -125,18 +127,26 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 });

 if (targets.includes('repos')) {
 const ctx = createSearchSelectContext();
 const repos = await searchSelect<string, true>({
 message: 'Repositories to index (type to search, or type owner/repo)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'repo');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'repo');
 } finally {
 ctx.setLoading(false);
 }
 },
 validate: (selected) => {
 for (const opt of selected) {
Expand All@@ -151,36 +161,52 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('orgs')) {
 const ctx = createSearchSelectContext();
 const orgs = await searchSelect<string, true>({
 message: 'Organizations to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'org');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'org');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.orgs = orgs;
 }

 if (targets.includes('users')) {
 const ctx = createSearchSelectContext();
 const users = await searchSelect<string, true>({
 message: 'GitHub users to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'user');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'user');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.users = users;
Expand Down

50 changes: 38 additions & 12 deletions
packages/setupWizard/src/gitlab.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import { select as searchSelect, Separator } from 'inquirer-select-pro';
import type { GitlabConnectionConfig } from '@sourcebot/schemas/v3/gitlab.type';
import type { CollectResult, EnvVars } from './utils.js';
import { note, toEnvKey } from './utils.js';
import { createSearchSelectContext, INPUT_THEME, note, toEnvKey } from './utils.js';

function gitlabApiBase(url: string): string {
 try {
Expand DownExpand Up@@ -89,6 +90,7 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 const url = await input({
 message: 'GitLab URL',
 default: 'https://gitlab.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand All@@ -114,7 +116,7 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle

 const gitlabEnvKey = toEnvKey(connectionName, 'TOKEN');
 const gitlabToken = await password({
 message: `GitLab Personal Access Token (stored as ${gitlabEnvKey}, leave blank for public repos only)`,
 message: `GitLab Personal Access Token (stored locally in .env as ${gitlabEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (gitlabToken.trim()) {
Expand DownExpand Up@@ -143,36 +145,52 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('groups')) {
 const ctx = createSearchSelectContext();
 const groups = await searchSelect<string, true>({
 message: 'Groups to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'group');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'group');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.groups = groups;
 }

 if (targets.includes('projects')) {
 const ctx = createSearchSelectContext();
 const projects = await searchSelect<string, true>({
 message: 'Projects to index (type to search, or type group/project)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'project');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'project');
 } finally {
 ctx.setLoading(false);
 }
 },
 validate: (selected) => {
 for (const opt of selected) {
Expand All@@ -187,18 +205,26 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('users')) {
 const ctx = createSearchSelectContext();
 const users = await searchSelect<string, true>({
 message: 'Users to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'user');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'user');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.users = users;
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(setup-wizard): improve setup wizard UX and Docker conflict handling#1232

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

msukkari
merged 3 commits into

from

May 28, 2026
 Merged


feat(setup-wizard): improve setup wizard UX and Docker conflict handling
#1232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
d4e63ca

feat(setup-wizard): improve setup wizard UX and add Docker conflict h…


msukkari May 27, 2026
1191d69

docs: add CHANGELOG entry for #1232


msukkari May 27, 2026
4593f99

chore(setup-wizard): bump version to 0.1.4


msukkari May 27, 2026

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed
- Redesigned the app layout with a new collapsible sidebar navigation, replacing the previous top navigation bar. [#1097](https://github.com/sourcebot-dev/sourcebot/pull/1097)
- Expired offline license keys no longer crash the process. An expired key now degrades to the unlicensed state. [#1109](https://github.com/sourcebot-dev/sourcebot/pull/1109)
- Improved the `setup-sourcebot` wizard: prompts for a setup directory, clarifies that secrets are stored locally in `.env`, switches multi-select to Tab, hides "No results" until a real search runs, and detects/cleans up conflicting Docker deployments and volumes before starting. [#1232](https://github.com/sourcebot-dev/sourcebot/pull/1232)

## [4.17.2] - 2026-05-16

Expand Down

2 changes: 1 addition & 1 deletion
packages/setupWizard/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
 "name": "setup-sourcebot",
 "version": "0.1.3",
 "version": "0.1.4",
 "description": "CLI wizard for creating a Sourcebot configuration.",
 "type": "module",
 "bin": "./dist/index.js",
Expand Down

5 changes: 3 additions & 2 deletions
packages/setupWizard/src/azuredevops.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { checkbox, confirm, input, password, select } from '@inquirer/prompts';
import { confirm, input, password, select } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { AzureDevOpsConnectionConfig } from '@sourcebot/schemas/v3/azuredevops.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, note, toEnvKey } from './utils.js';
Expand DownExpand Up@@ -57,7 +58,7 @@ export async function collectAzureDevOpsConfig(connectionName: string): Promise<

 const envKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Azure DevOps Personal Access Token (stored as ${envKey})`,
 message: `Azure DevOps Personal Access Token (stored locally in .env as ${envKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand Down

11 changes: 6 additions & 5 deletions
packages/setupWizard/src/bitbucket.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { checkbox, confirm, input, password, select } from '@inquirer/prompts';
import { confirm, input, password, select } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { BitbucketConnectionConfig } from '@sourcebot/schemas/v3/bitbucket.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, note, toEnvKey } from './utils.js';
Expand DownExpand Up@@ -78,7 +79,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `API Token (stored as ${tokenEnvKey})`,
 message: `API Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand All@@ -95,7 +96,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Access Token (stored as ${tokenEnvKey})`,
 message: `Access Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand All@@ -121,7 +122,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'APP_PASSWORD');
 const token = await password({
 message: `Bitbucket App Password (stored as ${tokenEnvKey})`,
 message: `Bitbucket App Password (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'App Password is required' : true,
 });
Expand DownExpand Up@@ -193,7 +194,7 @@ async function collectBitbucketServer(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Bitbucket HTTP Access Token (stored as ${tokenEnvKey})`,
 message: `Bitbucket HTTP Access Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand Down

8 changes: 5 additions & 3 deletions
packages/setupWizard/src/gitea.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { GiteaConnectionConfig } from '@sourcebot/schemas/v3/gitea.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, toEnvKey } from './utils.js';
import { INPUT_THEME, multiInput, toEnvKey } from './utils.js';

export async function collectGiteaConfig(connectionName: string): Promise<CollectResult> {
 const env: EnvVars = {};
Expand All@@ -10,6 +11,7 @@ export async function collectGiteaConfig(connectionName: string): Promise<Collec
 const url = await input({
 message: 'Gitea URL',
 default: 'https://gitea.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand All@@ -26,7 +28,7 @@ export async function collectGiteaConfig(connectionName: string): Promise<Collec

 const giteaEnvKey = toEnvKey(connectionName, 'TOKEN');
 const giteaToken = await password({
 message: `Gitea Access Token (stored as ${giteaEnvKey}, leave blank for public repos only)`,
 message: `Gitea Access Token (stored locally in .env as ${giteaEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (giteaToken.trim()) {
Expand Down

50 changes: 38 additions & 12 deletions
packages/setupWizard/src/github.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import { select as searchSelect, Separator } from 'inquirer-select-pro';
import type { GithubConnectionConfig } from '@sourcebot/schemas/v3/github.type';
import type { CollectResult, EnvVars } from './utils.js';
import { note, toEnvKey } from './utils.js';
import { createSearchSelectContext, INPUT_THEME, note, toEnvKey } from './utils.js';

function githubApiBase(url: string): string {
 try {
Expand DownExpand Up@@ -75,6 +76,7 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 const url = await input({
 message: 'GitHub URL',
 default: 'https://github.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand DownExpand Up@@ -104,7 +106,7 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `GitHub Personal Access Token (stored as ${tokenEnvKey}, leave blank for public repos only)`,
 message: `GitHub Personal Access Token (stored locally in .env as ${tokenEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (token.trim()) {
Expand All@@ -125,18 +127,26 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 });

 if (targets.includes('repos')) {
 const ctx = createSearchSelectContext();
 const repos = await searchSelect<string, true>({
 message: 'Repositories to index (type to search, or type owner/repo)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'repo');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'repo');
 } finally {
 ctx.setLoading(false);
 }
 },
 validate: (selected) => {
 for (const opt of selected) {
Expand All@@ -151,36 +161,52 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('orgs')) {
 const ctx = createSearchSelectContext();
 const orgs = await searchSelect<string, true>({
 message: 'Organizations to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'org');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'org');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.orgs = orgs;
 }

 if (targets.includes('users')) {
 const ctx = createSearchSelectContext();
 const users = await searchSelect<string, true>({
 message: 'GitHub users to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'user');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'user');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.users = users;
Expand Down

50 changes: 38 additions & 12 deletions
packages/setupWizard/src/gitlab.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import { select as searchSelect, Separator } from 'inquirer-select-pro';
import type { GitlabConnectionConfig } from '@sourcebot/schemas/v3/gitlab.type';
import type { CollectResult, EnvVars } from './utils.js';
import { note, toEnvKey } from './utils.js';
import { createSearchSelectContext, INPUT_THEME, note, toEnvKey } from './utils.js';

function gitlabApiBase(url: string): string {
 try {
Expand DownExpand Up@@ -89,6 +90,7 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 const url = await input({
 message: 'GitLab URL',
 default: 'https://gitlab.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand All@@ -114,7 +116,7 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle

 const gitlabEnvKey = toEnvKey(connectionName, 'TOKEN');
 const gitlabToken = await password({
 message: `GitLab Personal Access Token (stored as ${gitlabEnvKey}, leave blank for public repos only)`,
 message: `GitLab Personal Access Token (stored locally in .env as ${gitlabEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (gitlabToken.trim()) {
Expand DownExpand Up@@ -143,36 +145,52 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('groups')) {
 const ctx = createSearchSelectContext();
 const groups = await searchSelect<string, true>({
 message: 'Groups to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'group');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'group');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.groups = groups;
 }

 if (targets.includes('projects')) {
 const ctx = createSearchSelectContext();
 const projects = await searchSelect<string, true>({
 message: 'Projects to index (type to search, or type group/project)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'project');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'project');
 } finally {
 ctx.setLoading(false);
 }
 },
 validate: (selected) => {
 for (const opt of selected) {
Expand All@@ -187,18 +205,26 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('users')) {
 const ctx = createSearchSelectContext();
 const users = await searchSelect<string, true>({
 message: 'Users to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'user');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'user');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.users = users;
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
feat(setup-wizard): improve setup wizard UX and Docker conflict handling#1232

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

msukkari
merged 3 commits into

from

May 28, 2026
 Merged


feat(setup-wizard): improve setup wizard UX and Docker conflict handling
#1232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
d4e63ca

feat(setup-wizard): improve setup wizard UX and add Docker conflict h…


msukkari May 27, 2026
1191d69

docs: add CHANGELOG entry for #1232


msukkari May 27, 2026
4593f99

chore(setup-wizard): bump version to 0.1.4


msukkari May 27, 2026

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed
- Redesigned the app layout with a new collapsible sidebar navigation, replacing the previous top navigation bar. [#1097](https://github.com/sourcebot-dev/sourcebot/pull/1097)
- Expired offline license keys no longer crash the process. An expired key now degrades to the unlicensed state. [#1109](https://github.com/sourcebot-dev/sourcebot/pull/1109)
- Improved the `setup-sourcebot` wizard: prompts for a setup directory, clarifies that secrets are stored locally in `.env`, switches multi-select to Tab, hides "No results" until a real search runs, and detects/cleans up conflicting Docker deployments and volumes before starting. [#1232](https://github.com/sourcebot-dev/sourcebot/pull/1232)

## [4.17.2] - 2026-05-16

Expand Down

2 changes: 1 addition & 1 deletion
packages/setupWizard/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
 "name": "setup-sourcebot",
 "version": "0.1.3",
 "version": "0.1.4",
 "description": "CLI wizard for creating a Sourcebot configuration.",
 "type": "module",
 "bin": "./dist/index.js",
Expand Down

5 changes: 3 additions & 2 deletions
packages/setupWizard/src/azuredevops.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { checkbox, confirm, input, password, select } from '@inquirer/prompts';
import { confirm, input, password, select } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { AzureDevOpsConnectionConfig } from '@sourcebot/schemas/v3/azuredevops.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, note, toEnvKey } from './utils.js';
Expand DownExpand Up@@ -57,7 +58,7 @@ export async function collectAzureDevOpsConfig(connectionName: string): Promise<

 const envKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Azure DevOps Personal Access Token (stored as ${envKey})`,
 message: `Azure DevOps Personal Access Token (stored locally in .env as ${envKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand Down

11 changes: 6 additions & 5 deletions
packages/setupWizard/src/bitbucket.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { checkbox, confirm, input, password, select } from '@inquirer/prompts';
import { confirm, input, password, select } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { BitbucketConnectionConfig } from '@sourcebot/schemas/v3/bitbucket.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, note, toEnvKey } from './utils.js';
Expand DownExpand Up@@ -78,7 +79,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `API Token (stored as ${tokenEnvKey})`,
 message: `API Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand All@@ -95,7 +96,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Access Token (stored as ${tokenEnvKey})`,
 message: `Access Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand All@@ -121,7 +122,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'APP_PASSWORD');
 const token = await password({
 message: `Bitbucket App Password (stored as ${tokenEnvKey})`,
 message: `Bitbucket App Password (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'App Password is required' : true,
 });
Expand DownExpand Up@@ -193,7 +194,7 @@ async function collectBitbucketServer(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Bitbucket HTTP Access Token (stored as ${tokenEnvKey})`,
 message: `Bitbucket HTTP Access Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand Down

8 changes: 5 additions & 3 deletions
packages/setupWizard/src/gitea.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { GiteaConnectionConfig } from '@sourcebot/schemas/v3/gitea.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, toEnvKey } from './utils.js';
import { INPUT_THEME, multiInput, toEnvKey } from './utils.js';

export async function collectGiteaConfig(connectionName: string): Promise<CollectResult> {
 const env: EnvVars = {};
Expand All@@ -10,6 +11,7 @@ export async function collectGiteaConfig(connectionName: string): Promise<Collec
 const url = await input({
 message: 'Gitea URL',
 default: 'https://gitea.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand All@@ -26,7 +28,7 @@ export async function collectGiteaConfig(connectionName: string): Promise<Collec

 const giteaEnvKey = toEnvKey(connectionName, 'TOKEN');
 const giteaToken = await password({
 message: `Gitea Access Token (stored as ${giteaEnvKey}, leave blank for public repos only)`,
 message: `Gitea Access Token (stored locally in .env as ${giteaEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (giteaToken.trim()) {
Expand Down

50 changes: 38 additions & 12 deletions
packages/setupWizard/src/github.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import { select as searchSelect, Separator } from 'inquirer-select-pro';
import type { GithubConnectionConfig } from '@sourcebot/schemas/v3/github.type';
import type { CollectResult, EnvVars } from './utils.js';
import { note, toEnvKey } from './utils.js';
import { createSearchSelectContext, INPUT_THEME, note, toEnvKey } from './utils.js';

function githubApiBase(url: string): string {
 try {
Expand DownExpand Up@@ -75,6 +76,7 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 const url = await input({
 message: 'GitHub URL',
 default: 'https://github.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand DownExpand Up@@ -104,7 +106,7 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `GitHub Personal Access Token (stored as ${tokenEnvKey}, leave blank for public repos only)`,
 message: `GitHub Personal Access Token (stored locally in .env as ${tokenEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (token.trim()) {
Expand All@@ -125,18 +127,26 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 });

 if (targets.includes('repos')) {
 const ctx = createSearchSelectContext();
 const repos = await searchSelect<string, true>({
 message: 'Repositories to index (type to search, or type owner/repo)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'repo');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'repo');
 } finally {
 ctx.setLoading(false);
 }
 },
 validate: (selected) => {
 for (const opt of selected) {
Expand All@@ -151,36 +161,52 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('orgs')) {
 const ctx = createSearchSelectContext();
 const orgs = await searchSelect<string, true>({
 message: 'Organizations to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'org');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'org');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.orgs = orgs;
 }

 if (targets.includes('users')) {
 const ctx = createSearchSelectContext();
 const users = await searchSelect<string, true>({
 message: 'GitHub users to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'user');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'user');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.users = users;
Expand Down

50 changes: 38 additions & 12 deletions
packages/setupWizard/src/gitlab.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import { select as searchSelect, Separator } from 'inquirer-select-pro';
import type { GitlabConnectionConfig } from '@sourcebot/schemas/v3/gitlab.type';
import type { CollectResult, EnvVars } from './utils.js';
import { note, toEnvKey } from './utils.js';
import { createSearchSelectContext, INPUT_THEME, note, toEnvKey } from './utils.js';

function gitlabApiBase(url: string): string {
 try {
Expand DownExpand Up@@ -89,6 +90,7 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 const url = await input({
 message: 'GitLab URL',
 default: 'https://gitlab.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand All@@ -114,7 +116,7 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle

 const gitlabEnvKey = toEnvKey(connectionName, 'TOKEN');
 const gitlabToken = await password({
 message: `GitLab Personal Access Token (stored as ${gitlabEnvKey}, leave blank for public repos only)`,
 message: `GitLab Personal Access Token (stored locally in .env as ${gitlabEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (gitlabToken.trim()) {
Expand DownExpand Up@@ -143,36 +145,52 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('groups')) {
 const ctx = createSearchSelectContext();
 const groups = await searchSelect<string, true>({
 message: 'Groups to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'group');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'group');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.groups = groups;
 }

 if (targets.includes('projects')) {
 const ctx = createSearchSelectContext();
 const projects = await searchSelect<string, true>({
 message: 'Projects to index (type to search, or type group/project)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'project');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'project');
 } finally {
 ctx.setLoading(false);
 }
 },
 validate: (selected) => {
 for (const opt of selected) {
Expand All@@ -187,18 +205,26 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('users')) {
 const ctx = createSearchSelectContext();
 const users = await searchSelect<string, true>({
 message: 'Users to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'user');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'user');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.users = users;
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
feat(setup-wizard): improve setup wizard UX and Docker conflict handling#1232

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

msukkari
merged 3 commits into

from

May 28, 2026
 Merged


feat(setup-wizard): improve setup wizard UX and Docker conflict handling
#1232
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
d4e63ca

feat(setup-wizard): improve setup wizard UX and add Docker conflict h…


msukkari May 27, 2026
1191d69

docs: add CHANGELOG entry for #1232


msukkari May 27, 2026
4593f99

chore(setup-wizard): bump version to 0.1.4


msukkari May 27, 2026

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


1 change: 1 addition & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Changed
- Redesigned the app layout with a new collapsible sidebar navigation, replacing the previous top navigation bar. [#1097](https://github.com/sourcebot-dev/sourcebot/pull/1097)
- Expired offline license keys no longer crash the process. An expired key now degrades to the unlicensed state. [#1109](https://github.com/sourcebot-dev/sourcebot/pull/1109)
- Improved the `setup-sourcebot` wizard: prompts for a setup directory, clarifies that secrets are stored locally in `.env`, switches multi-select to Tab, hides "No results" until a real search runs, and detects/cleans up conflicting Docker deployments and volumes before starting. [#1232](https://github.com/sourcebot-dev/sourcebot/pull/1232)

## [4.17.2] - 2026-05-16

Expand Down

2 changes: 1 addition & 1 deletion
packages/setupWizard/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
{
 "name": "setup-sourcebot",
 "version": "0.1.3",
 "version": "0.1.4",
 "description": "CLI wizard for creating a Sourcebot configuration.",
 "type": "module",
 "bin": "./dist/index.js",
Expand Down

5 changes: 3 additions & 2 deletions
packages/setupWizard/src/azuredevops.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { checkbox, confirm, input, password, select } from '@inquirer/prompts';
import { confirm, input, password, select } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { AzureDevOpsConnectionConfig } from '@sourcebot/schemas/v3/azuredevops.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, note, toEnvKey } from './utils.js';
Expand DownExpand Up@@ -57,7 +58,7 @@ export async function collectAzureDevOpsConfig(connectionName: string): Promise<

 const envKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Azure DevOps Personal Access Token (stored as ${envKey})`,
 message: `Azure DevOps Personal Access Token (stored locally in .env as ${envKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand Down

11 changes: 6 additions & 5 deletions
packages/setupWizard/src/bitbucket.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
import { checkbox, confirm, input, password, select } from '@inquirer/prompts';
import { confirm, input, password, select } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { BitbucketConnectionConfig } from '@sourcebot/schemas/v3/bitbucket.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, note, toEnvKey } from './utils.js';
Expand DownExpand Up@@ -78,7 +79,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `API Token (stored as ${tokenEnvKey})`,
 message: `API Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand All@@ -95,7 +96,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Access Token (stored as ${tokenEnvKey})`,
 message: `Access Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand All@@ -121,7 +122,7 @@ async function collectBitbucketCloud(

 const tokenEnvKey = toEnvKey(connectionName, 'APP_PASSWORD');
 const token = await password({
 message: `Bitbucket App Password (stored as ${tokenEnvKey})`,
 message: `Bitbucket App Password (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'App Password is required' : true,
 });
Expand DownExpand Up@@ -193,7 +194,7 @@ async function collectBitbucketServer(

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `Bitbucket HTTP Access Token (stored as ${tokenEnvKey})`,
 message: `Bitbucket HTTP Access Token (stored locally in .env as ${tokenEnvKey})`,
 mask: true,
 validate: (v) => !v?.trim() ? 'Token is required' : true,
 });
Expand Down

8 changes: 5 additions & 3 deletions
packages/setupWizard/src/gitea.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import type { GiteaConnectionConfig } from '@sourcebot/schemas/v3/gitea.type';
import type { CollectResult, EnvVars } from './utils.js';
import { multiInput, toEnvKey } from './utils.js';
import { INPUT_THEME, multiInput, toEnvKey } from './utils.js';

export async function collectGiteaConfig(connectionName: string): Promise<CollectResult> {
 const env: EnvVars = {};
Expand All@@ -10,6 +11,7 @@ export async function collectGiteaConfig(connectionName: string): Promise<Collec
 const url = await input({
 message: 'Gitea URL',
 default: 'https://gitea.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand All@@ -26,7 +28,7 @@ export async function collectGiteaConfig(connectionName: string): Promise<Collec

 const giteaEnvKey = toEnvKey(connectionName, 'TOKEN');
 const giteaToken = await password({
 message: `Gitea Access Token (stored as ${giteaEnvKey}, leave blank for public repos only)`,
 message: `Gitea Access Token (stored locally in .env as ${giteaEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (giteaToken.trim()) {
Expand Down

50 changes: 38 additions & 12 deletions
packages/setupWizard/src/github.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import { select as searchSelect, Separator } from 'inquirer-select-pro';
import type { GithubConnectionConfig } from '@sourcebot/schemas/v3/github.type';
import type { CollectResult, EnvVars } from './utils.js';
import { note, toEnvKey } from './utils.js';
import { createSearchSelectContext, INPUT_THEME, note, toEnvKey } from './utils.js';

function githubApiBase(url: string): string {
 try {
Expand DownExpand Up@@ -75,6 +76,7 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 const url = await input({
 message: 'GitHub URL',
 default: 'https://github.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand DownExpand Up@@ -104,7 +106,7 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle

 const tokenEnvKey = toEnvKey(connectionName, 'TOKEN');
 const token = await password({
 message: `GitHub Personal Access Token (stored as ${tokenEnvKey}, leave blank for public repos only)`,
 message: `GitHub Personal Access Token (stored locally in .env as ${tokenEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (token.trim()) {
Expand All@@ -125,18 +127,26 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 });

 if (targets.includes('repos')) {
 const ctx = createSearchSelectContext();
 const repos = await searchSelect<string, true>({
 message: 'Repositories to index (type to search, or type owner/repo)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'repo');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'repo');
 } finally {
 ctx.setLoading(false);
 }
 },
 validate: (selected) => {
 for (const opt of selected) {
Expand All@@ -151,36 +161,52 @@ export async function collectGitHubConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('orgs')) {
 const ctx = createSearchSelectContext();
 const orgs = await searchSelect<string, true>({
 message: 'Organizations to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'org');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'org');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.orgs = orgs;
 }

 if (targets.includes('users')) {
 const ctx = createSearchSelectContext();
 const users = await searchSelect<string, true>({
 message: 'GitHub users to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitHub(apiBase, search, token, 'user');
 ctx.setLoading(true);
 try {
 return await searchGitHub(apiBase, search, token, 'user');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.users = users;
Expand Down

50 changes: 38 additions & 12 deletions
packages/setupWizard/src/gitlab.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
import { checkbox, input, password } from '@inquirer/prompts';
import { input, password } from '@inquirer/prompts';
import { tabCheckbox as checkbox } from './tabCheckbox.js';
import { select as searchSelect, Separator } from 'inquirer-select-pro';
import type { GitlabConnectionConfig } from '@sourcebot/schemas/v3/gitlab.type';
import type { CollectResult, EnvVars } from './utils.js';
import { note, toEnvKey } from './utils.js';
import { createSearchSelectContext, INPUT_THEME, note, toEnvKey } from './utils.js';

function gitlabApiBase(url: string): string {
 try {
Expand DownExpand Up@@ -89,6 +90,7 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 const url = await input({
 message: 'GitLab URL',
 default: 'https://gitlab.com',
 theme: INPUT_THEME,
 validate: (v) => {
 if (!v?.trim()) {
 return 'URL is required';
Expand All@@ -114,7 +116,7 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle

 const gitlabEnvKey = toEnvKey(connectionName, 'TOKEN');
 const gitlabToken = await password({
 message: `GitLab Personal Access Token (stored as ${gitlabEnvKey}, leave blank for public repos only)`,
 message: `GitLab Personal Access Token (stored locally in .env as ${gitlabEnvKey}, leave blank for public repos only)`,
 mask: true,
 });
 if (gitlabToken.trim()) {
Expand DownExpand Up@@ -143,36 +145,52 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('groups')) {
 const ctx = createSearchSelectContext();
 const groups = await searchSelect<string, true>({
 message: 'Groups to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'group');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'group');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.groups = groups;
 }

 if (targets.includes('projects')) {
 const ctx = createSearchSelectContext();
 const projects = await searchSelect<string, true>({
 message: 'Projects to index (type to search, or type group/project)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'project');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'project');
 } finally {
 ctx.setLoading(false);
 }
 },
 validate: (selected) => {
 for (const opt of selected) {
Expand All@@ -187,18 +205,26 @@ export async function collectGitLabConfig(connectionName: string): Promise<Colle
 }

 if (targets.includes('users')) {
 const ctx = createSearchSelectContext();
 const users = await searchSelect<string, true>({
 message: 'Users to index (type to search)',
 multiple: true,
 required: true,
 loop: false,
 clearInputWhenSelected: true,
 placeholder: 'Type 2+ characters to search...',
 theme: ctx.theme,
 placeholder: 'Type to search...',
 options: async (search) => {
 if (!search || search.length < 2) {
 ctx.trackSearch(search);
 if (!search) {
 return [];
 }
 return searchGitLab(apiBase, search, gitlabToken, 'user');
 ctx.setLoading(true);
 try {
 return await searchGitLab(apiBase, search, gitlabToken, 'user');
 } finally {
 ctx.setLoading(false);
 }
 },
 });
 config.users = users;
Expand Down
Loading
Loading