@hubspot/cli 8.3.1-experimental.0 → 8.3.1-experimental.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api/feedback.d.ts +10 -0
- package/api/feedback.js +9 -0
- package/bin/cli.js +19 -1
- package/commands/account/auth.js +2 -2
- package/commands/account/createOverride.js +2 -0
- package/commands/account/removeOverride.js +2 -0
- package/commands/app/secret/add.js +1 -1
- package/commands/app/secret/delete.js +1 -1
- package/commands/app/secret/list.js +1 -1
- package/commands/app/secret/update.js +1 -1
- package/commands/app/secret.js +1 -1
- package/commands/auth.js +3 -2
- package/commands/cms/function/create.js +5 -37
- package/commands/cms/function/deploy.js +8 -1
- package/commands/cms/function/list.js +4 -0
- package/commands/cms/function/logs.js +2 -0
- package/commands/cms/function/server.js +6 -0
- package/commands/cms/lighthouseScore.js +1 -1
- package/commands/cms/upload.js +6 -0
- package/commands/cms/watch.js +2 -0
- package/commands/cms/webpack/create.js +5 -32
- package/commands/customObject.js +2 -2
- package/commands/feedback.d.ts +6 -2
- package/commands/feedback.js +82 -8
- package/commands/getStarted.js +4 -4
- package/commands/hubdb/list.js +2 -2
- package/commands/init.js +3 -2
- package/commands/mcp/setup.d.ts +1 -0
- package/commands/mcp/setup.js +11 -3
- package/commands/project/dev/index.js +2 -2
- package/commands/project/download.d.ts +2 -0
- package/commands/project/download.js +56 -16
- package/commands/project/logs.js +2 -2
- package/commands/project/upload.js +6 -2
- package/commands/project/watch.js +2 -2
- package/commands/sandbox/create.js +3 -3
- package/commands/sandbox/delete.js +1 -1
- package/commands/sandbox.js +1 -1
- package/lang/en.d.ts +105 -6
- package/lang/en.js +269 -51
- package/lib/accountAuth.js +12 -0
- package/lib/accountCredentials.d.ts +1 -0
- package/lib/accountCredentials.js +25 -0
- package/lib/agentHelp.d.ts +17 -0
- package/lib/agentHelp.js +90 -0
- package/lib/app/migrate.js +5 -8
- package/lib/commonOpts.js +4 -0
- package/lib/constants.d.ts +4 -0
- package/lib/constants.js +6 -0
- package/lib/errorHandlers/suppressError.js +3 -3
- package/lib/feedback.d.ts +3 -0
- package/lib/feedback.js +13 -0
- package/lib/jsonOutput/projectDownload.d.ts +1 -0
- package/lib/jsonOutput/projectDownload.js +1 -0
- package/lib/jsonOutput/projectUpload.d.ts +1 -0
- package/lib/jsonOutput/projectUpload.js +1 -0
- package/lib/mcp/clients.d.ts +2 -1
- package/lib/mcp/clients.js +7 -7
- package/lib/mcp/setup.d.ts +7 -2
- package/lib/mcp/setup.js +22 -37
- package/lib/mcp/skills.d.ts +8 -0
- package/lib/mcp/skills.js +64 -0
- package/lib/projects/archive.d.ts +8 -0
- package/lib/projects/archive.js +104 -0
- package/lib/projects/archiveDiff.d.ts +12 -0
- package/lib/projects/archiveDiff.js +68 -0
- package/lib/projects/config.js +1 -1
- package/lib/projects/download.d.ts +37 -0
- package/lib/projects/download.js +123 -0
- package/lib/projects/localDev/AppDevModeInterface.js +3 -3
- package/lib/projects/localDev/LocalDevLogger.js +5 -5
- package/lib/projects/localDev/LocalDevWatcher.js +2 -1
- package/lib/projects/localDev/helpers/project.js +3 -3
- package/lib/projects/pollProjectBuildAndDeploy.js +4 -4
- package/lib/projects/projectInfo.js +4 -4
- package/lib/projects/projectProfiles.js +3 -3
- package/lib/projects/ui.js +3 -3
- package/lib/projects/upload.d.ts +3 -1
- package/lib/projects/upload.js +23 -6
- package/lib/projects/watch.js +4 -2
- package/lib/projects/workspaces.js +4 -4
- package/lib/prompts/importDataTestAccountSelectPrompt.js +1 -1
- package/lib/prompts/personalAccessKeyPrompt.js +2 -2
- package/lib/prompts/selectPublicAppForMigrationPrompt.js +3 -3
- package/lib/serverlessSunset.d.ts +6 -0
- package/lib/serverlessSunset.js +32 -0
- package/lib/testUtils.d.ts +5 -1
- package/lib/testUtils.js +2 -2
- package/lib/ui/appLogs.js +3 -3
- package/lib/ui/git.js +3 -3
- package/lib/ui/index.d.ts +8 -10
- package/lib/ui/index.js +34 -31
- package/lib/validation.js +16 -1
- package/lib/yargs/makeWrappedYargsHandler.d.ts +1 -0
- package/lib/yargs/makeWrappedYargsHandler.js +7 -0
- package/mcp-server/Tool.d.ts +1 -0
- package/mcp-server/Tool.js +4 -1
- package/mcp-server/server.js +16 -5
- package/mcp-server/skills/hubspot-fix-build/SKILL.md +61 -0
- package/mcp-server/skills/hubspot-new-app/SKILL.md +84 -0
- package/mcp-server/tools/cms/HsFunctionLogsTool.js +1 -1
- package/mcp-server/tools/cms/HsListFunctionsTool.js +1 -1
- package/mcp-server/tools/index.js +2 -2
- package/mcp-server/tools/project/DocFetchTool.d.ts +4 -1
- package/mcp-server/tools/project/DocFetchTool.js +53 -12
- package/mcp-server/tools/project/DocsSearchTool.js +2 -7
- package/mcp-server/tools/project/FindProjectsTool.js +4 -1
- package/mcp-server/tools/project/GetApiUsagePatternsByAppIdTool.js +2 -7
- package/mcp-server/tools/project/GetApplicationInfoTool.js +2 -7
- package/mcp-server/tools/project/GetBuildLogsTool.d.ts +1 -1
- package/mcp-server/tools/project/GetBuildLogsTool.js +2 -12
- package/mcp-server/tools/project/GetBuildStatusTool.js +2 -12
- package/mcp-server/tools/project/KnowledgeSearchTool.js +2 -5
- package/mcp-server/tools/project/SubmitFeedbackTool.d.ts +25 -0
- package/mcp-server/tools/project/SubmitFeedbackTool.js +73 -0
- package/mcp-server/utils/command.js +23 -4
- package/mcp-server/utils/errors.d.ts +1 -0
- package/mcp-server/utils/errors.js +9 -0
- package/mcp-server/utils/feedbackTracking.js +3 -1
- package/package.json +14 -14
- package/mcp-server/tools/cms/HsCreateFunctionTool.d.ts +0 -26
- package/mcp-server/tools/cms/HsCreateFunctionTool.js +0 -100
package/lang/en.js
CHANGED
|
@@ -2,12 +2,27 @@ import chalk from 'chalk';
|
|
|
2
2
|
import { mapToUserFriendlyName } from '@hubspot/project-parsing-lib/transform';
|
|
3
3
|
import { PLATFORM_VERSIONS } from '@hubspot/project-parsing-lib/constants';
|
|
4
4
|
import { PERSONAL_ACCESS_KEY_AUTH_METHOD } from '@hubspot/local-dev-lib/constants/auth';
|
|
5
|
-
import { APP_AUTH_TYPES, APP_DISTRIBUTION_TYPES, CLI_SUPPORT_GUIDELINES_URL, LEGACY_PUBLIC_APP_FILE, LOCAL_DEV_DEFAULT_PORT, PROJECT_CONFIG_FILE, PROJECT_WITH_APP, } from '../lib/constants.js';
|
|
5
|
+
import { APP_AUTH_TYPES, APP_DISTRIBUTION_TYPES, CLI_SUPPORT_GUIDELINES_URL, FEEDBACK_SOURCE_ENV_VAR, LEGACY_PUBLIC_APP_FILE, LOCAL_DEV_DEFAULT_PORT, MAX_FEEDBACK_LENGTH, PROJECT_CONFIG_FILE, PROJECT_WITH_APP, SERVERLESS_SUNSET_CHANGELOG_URL, } from '../lib/constants.js';
|
|
6
6
|
import { ARCHIVED_HUBSPOT_CONFIG_YAML_FILE_NAME, DEFAULT_HUBSPOT_CONFIG_YAML_FILE_NAME, GLOBAL_CONFIG_PATH, } from '@hubspot/local-dev-lib/constants/config';
|
|
7
7
|
import { indent, UI_COLORS, uiAccountDescription, uiAuthCommandReference, uiBetaTag, uiCommandReference, uiDeprecatedTag, uiLink, } from '../lib/ui/index.js';
|
|
8
8
|
import { getLocalDevUiUrl, getProjectDetailUrl, getProjectSettingsUrl, } from '../lib/projects/urls.js';
|
|
9
9
|
import { getProductUpdatesUrl } from '../lib/links.js';
|
|
10
|
+
const AGENT_HELP_EXIT_CODES = '0 means success. 1 means an error. 2 means a warning, for example a validation issue or JSON output that does not match its schema.';
|
|
10
11
|
const MIGRATION_SUPPORT_CUTOFF_NOTICE = 'Automated platform version migrations beyond 2026.09 will not be supported.';
|
|
12
|
+
const SERVERLESS_SUNSET_NOTICE = 'CMS serverless functions are being sunset. Creating them has ended, editing ends on November 17, 2026, and existing functions stop running on February 1, 2027.';
|
|
13
|
+
const SERVERLESS_CREATION_BLOCKED_NOTICE = 'Serverless functions can no longer be created in the Design Manager. Build new serverless functions in Developer Projects instead.';
|
|
14
|
+
const SERVERLESS_CREATION_ENDED_NOTICE = 'Creating serverless functions has ended.';
|
|
15
|
+
const SERVERLESS_CHANGELOG_LINK_TEXT = 'Read more on the announcement and how to migrate your serverless functions to Developer Projects in the Developer Changelog.';
|
|
16
|
+
const LEGACY_CONFIG_REPLACEMENTS = [
|
|
17
|
+
['hs account auth', 'Create the global config file and add accounts'],
|
|
18
|
+
['hs account link', 'Link accounts to a project directory'],
|
|
19
|
+
['hs config migrate', 'Migrate your existing config'],
|
|
20
|
+
];
|
|
21
|
+
function getLegacyConfigDeprecationMessage(command) {
|
|
22
|
+
const columnWidth = Math.max(...LEGACY_CONFIG_REPLACEMENTS.map(([name]) => name.length)) + 3;
|
|
23
|
+
const replacements = LEGACY_CONFIG_REPLACEMENTS.map(([name, description]) => `${indent(1)}${uiCommandReference(name, false)}${' '.repeat(columnWidth - name.length)}${description}`);
|
|
24
|
+
return `${uiCommandReference(command)} is being replaced as we move to global config.\n\n${replacements.join('\n')}`;
|
|
25
|
+
}
|
|
11
26
|
export const commands = {
|
|
12
27
|
generalErrors: {
|
|
13
28
|
srcIsProject: (src, command) => `"${src}" is in a project folder. Did you mean "hs project ${command}"?`,
|
|
@@ -125,11 +140,14 @@ export const commands = {
|
|
|
125
140
|
account: 'HubSpot account to authenticate',
|
|
126
141
|
personalAccessKey: 'Enter existing personal access key',
|
|
127
142
|
default: 'Set the authenticated account as the default account',
|
|
128
|
-
name: 'Set a name for the account in the CLI config',
|
|
143
|
+
name: 'Set a name for the account in the CLI config (cannot contain spaces)',
|
|
129
144
|
useDefaultName: 'Use the account name derived from the HubSpot portal name',
|
|
130
145
|
},
|
|
131
146
|
errors: {
|
|
132
147
|
invalidAccountIdProvided: `--account must be a number.`,
|
|
148
|
+
accountNameContainsSpaces: (accountName, suggestedName) => suggestedName
|
|
149
|
+
? `The account name "${accountName}" cannot contain spaces. Try ${uiCommandReference(`--name ${suggestedName}`)}.`
|
|
150
|
+
: `The account name "${accountName}" cannot contain spaces. Provide a name without spaces.`,
|
|
133
151
|
failedToUpdateConfig: 'Failed to update the configuration file. Please try again.',
|
|
134
152
|
migrationNotConfirmed: `Did not migrate your configuration file. Run ${uiAuthCommandReference()} to update your existing config, or use ${uiCommandReference('hs config migrate')} to switch to the new global configuration.`,
|
|
135
153
|
mergeNotConfirmed: `Did not merge configuration files. When you are ready to merge the deprecated config file with the global config file, run ${uiCommandReference('hs config migrate')}.`,
|
|
@@ -285,7 +303,10 @@ export const commands = {
|
|
|
285
303
|
},
|
|
286
304
|
},
|
|
287
305
|
removeOverride: {
|
|
288
|
-
describe: (overrideFile) => `Remove the default account override file (${overrideFile}) from the current working directory
|
|
306
|
+
describe: (overrideFile) => uiDeprecatedTag(`Remove the default account override file (${overrideFile}) from the current working directory. Replaced by ${uiCommandReference('hs account unlink')}.`),
|
|
307
|
+
logs: {
|
|
308
|
+
deprecated: `${uiCommandReference('hs account remove-override')} is being replaced by ${uiCommandReference('hs account unlink')}.\nUse ${uiCommandReference('hs account unlink')} to unlink accounts from a project directory.`,
|
|
309
|
+
},
|
|
289
310
|
accountOverride: (overrideFilePath, accountOverride) => `There is an account override file at ${overrideFilePath} associated with account "${accountOverride}".`,
|
|
290
311
|
prompts: {
|
|
291
312
|
deleteOverrideFile: 'Delete account override file?',
|
|
@@ -348,7 +369,10 @@ export const commands = {
|
|
|
348
369
|
defaultAccountOverride: (overrideFilePath) => `\n(This will also delete the default account override file at ${overrideFilePath})`,
|
|
349
370
|
},
|
|
350
371
|
createOverride: {
|
|
351
|
-
describe: (hsAccountFileName) => `Create a new default account override file (${hsAccountFileName}) in the current working directory
|
|
372
|
+
describe: (hsAccountFileName) => uiDeprecatedTag(`Create a new default account override file (${hsAccountFileName}) in the current working directory. Replaced by ${uiCommandReference('hs account link')}.`),
|
|
373
|
+
logs: {
|
|
374
|
+
deprecated: `${uiCommandReference('hs account create-override')} is being replaced by ${uiCommandReference('hs account link')}.\nUse ${uiCommandReference('hs account link')} to link accounts to a project directory.`,
|
|
375
|
+
},
|
|
352
376
|
success: (overrideFilePath) => `Default account override file created at ${overrideFilePath}`,
|
|
353
377
|
accountOverride: (overrideFilePath, accountOverride) => `An account override file already exists at ${overrideFilePath} associated with account "${accountOverride}".`,
|
|
354
378
|
prompts: {
|
|
@@ -372,8 +396,11 @@ export const commands = {
|
|
|
372
396
|
},
|
|
373
397
|
},
|
|
374
398
|
auth: {
|
|
375
|
-
describe:
|
|
376
|
-
verboseDescribe: (configName, authMethod) => `Configure authentication for a HubSpot account. This will update the ${configName} file that stores your account information.\n\nThe recommended authentication method is ${chalk.bold(authMethod)}, which uses an access token tied to a specific user account
|
|
399
|
+
describe: uiDeprecatedTag(`Configure authentication for your HubSpot account. Replaced by ${uiCommandReference('hs account auth')}.`),
|
|
400
|
+
verboseDescribe: (configName, authMethod) => uiDeprecatedTag(`Configure authentication for a HubSpot account. This will update the ${configName} file that stores your account information.\n\nThe recommended authentication method is ${chalk.bold(authMethod)}, which uses an access token tied to a specific user account.\n\nThis command is deprecated because we are moving to global config, and the legacy config format will be replaced. Use ${uiCommandReference('hs account auth')} to create the global config file and add accounts to it, and ${uiCommandReference('hs account link')} to link accounts to a project directory. Run ${uiCommandReference('hs config migrate')} to migrate your existing config.`),
|
|
401
|
+
logs: {
|
|
402
|
+
deprecated: getLegacyConfigDeprecationMessage('hs auth'),
|
|
403
|
+
},
|
|
377
404
|
errors: {
|
|
378
405
|
invalidAccountIdProvided: `--account must be a number.`,
|
|
379
406
|
globalConfigFileExists: (accountAuthCommand) => `You are using our new global configuration for account management, which is not compatible with this command. Please use ${uiCommandReference(accountAuthCommand)} instead.`,
|
|
@@ -466,15 +493,15 @@ export const commands = {
|
|
|
466
493
|
},
|
|
467
494
|
},
|
|
468
495
|
webpack: {
|
|
469
|
-
describe: 'Commands for managing webpack.',
|
|
496
|
+
describe: uiDeprecatedTag('Commands for managing webpack.'),
|
|
470
497
|
subcommands: {
|
|
471
498
|
create: {
|
|
472
|
-
describe:
|
|
499
|
+
describe: uiDeprecatedTag(`Create a new webpack bundle. ${SERVERLESS_CREATION_ENDED_NOTICE}`),
|
|
473
500
|
errors: {
|
|
474
501
|
unusablePath: (path) => `The "${path}" is not a usable path to a directory.`,
|
|
475
502
|
},
|
|
476
503
|
positionals: {
|
|
477
|
-
dest: 'Destination folder for the new webpack bundle.',
|
|
504
|
+
dest: uiDeprecatedTag('Destination folder for the new webpack bundle.'),
|
|
478
505
|
},
|
|
479
506
|
},
|
|
480
507
|
},
|
|
@@ -789,26 +816,26 @@ export const commands = {
|
|
|
789
816
|
},
|
|
790
817
|
},
|
|
791
818
|
function: {
|
|
792
|
-
describe:
|
|
819
|
+
describe: uiDeprecatedTag(`Commands for managing CMS serverless functions. ${SERVERLESS_SUNSET_NOTICE}`),
|
|
793
820
|
subcommands: {
|
|
794
821
|
create: {
|
|
795
|
-
describe:
|
|
822
|
+
describe: uiDeprecatedTag(`Create a new CMS serverless function. ${SERVERLESS_CREATION_ENDED_NOTICE}`),
|
|
796
823
|
errors: {
|
|
797
824
|
unusablePath: (path) => `The "${path}" is not a usable path to a directory.`,
|
|
798
825
|
},
|
|
799
826
|
positionals: {
|
|
800
|
-
name: 'Name of the function',
|
|
801
|
-
dest: 'Destination folder for the function',
|
|
827
|
+
name: uiDeprecatedTag('Name of the function'),
|
|
828
|
+
dest: uiDeprecatedTag('Destination folder for the function'),
|
|
802
829
|
},
|
|
803
830
|
options: {
|
|
804
|
-
functionsFolder: 'Folder to create functions in',
|
|
805
|
-
filename: 'Filename for the function',
|
|
806
|
-
endpointMethod: 'HTTP method for the function endpoint',
|
|
807
|
-
endpointPath: 'API endpoint path for the function',
|
|
831
|
+
functionsFolder: uiDeprecatedTag('Folder to create functions in'),
|
|
832
|
+
filename: uiDeprecatedTag('Filename for the function'),
|
|
833
|
+
endpointMethod: uiDeprecatedTag('HTTP method for the function endpoint'),
|
|
834
|
+
endpointPath: uiDeprecatedTag('API endpoint path for the function'),
|
|
808
835
|
},
|
|
809
836
|
},
|
|
810
837
|
logs: {
|
|
811
|
-
describe: 'View logs for a CMS serverless function.',
|
|
838
|
+
describe: uiDeprecatedTag('View logs for a CMS serverless function.'),
|
|
812
839
|
errors: {
|
|
813
840
|
noLogsFound: (functionPath, accountId) => `No logs were found for the function path "${functionPath}" in account "${accountId}".`,
|
|
814
841
|
},
|
|
@@ -821,21 +848,21 @@ export const commands = {
|
|
|
821
848
|
gettingLogs: (latest, functionPath) => `Getting ${latest ? 'latest ' : ''}logs for function with path: ${functionPath}.`,
|
|
822
849
|
options: {
|
|
823
850
|
compact: {
|
|
824
|
-
describe: 'output compact logs',
|
|
851
|
+
describe: uiDeprecatedTag('output compact logs'),
|
|
825
852
|
},
|
|
826
853
|
follow: {
|
|
827
|
-
describe: 'follow logs',
|
|
854
|
+
describe: uiDeprecatedTag('follow logs'),
|
|
828
855
|
},
|
|
829
856
|
latest: {
|
|
830
|
-
describe: 'retrieve most recent log only',
|
|
857
|
+
describe: uiDeprecatedTag('retrieve most recent log only'),
|
|
831
858
|
},
|
|
832
859
|
limit: {
|
|
833
|
-
describe: 'limit the number of logs to output',
|
|
860
|
+
describe: uiDeprecatedTag('limit the number of logs to output'),
|
|
834
861
|
},
|
|
835
862
|
},
|
|
836
863
|
positionals: {
|
|
837
864
|
endpoint: {
|
|
838
|
-
describe: 'Serverless function endpoint',
|
|
865
|
+
describe: uiDeprecatedTag('Serverless function endpoint'),
|
|
839
866
|
},
|
|
840
867
|
},
|
|
841
868
|
tailLogs: (functionPath, accountId) => `Waiting for log entries for "${functionPath}" on account "${accountId}".\n`,
|
|
@@ -856,7 +883,7 @@ export const commands = {
|
|
|
856
883
|
loadingFailed: (functionPath, account) => `Failed to build and deploy bundle for "${functionPath}" on ${account}`,
|
|
857
884
|
positionals: {
|
|
858
885
|
path: {
|
|
859
|
-
describe: 'Path to the ".functions" folder',
|
|
886
|
+
describe: uiDeprecatedTag('Path to the ".functions" folder'),
|
|
860
887
|
},
|
|
861
888
|
},
|
|
862
889
|
success: {
|
|
@@ -867,13 +894,13 @@ export const commands = {
|
|
|
867
894
|
debug: {
|
|
868
895
|
gettingFunctions: 'Getting currently deployed functions',
|
|
869
896
|
},
|
|
870
|
-
describe: 'List the currently deployed CMS serverless functions.',
|
|
897
|
+
describe: uiDeprecatedTag('List the currently deployed CMS serverless functions.'),
|
|
871
898
|
info: {
|
|
872
899
|
noFunctions: 'No functions found',
|
|
873
900
|
},
|
|
874
901
|
options: {
|
|
875
902
|
json: {
|
|
876
|
-
describe: 'output raw json data',
|
|
903
|
+
describe: uiDeprecatedTag('output raw json data'),
|
|
877
904
|
},
|
|
878
905
|
},
|
|
879
906
|
},
|
|
@@ -886,21 +913,21 @@ export const commands = {
|
|
|
886
913
|
},
|
|
887
914
|
options: {
|
|
888
915
|
contact: {
|
|
889
|
-
describe: 'Pass contact data to the test function',
|
|
916
|
+
describe: uiDeprecatedTag('Pass contact data to the test function'),
|
|
890
917
|
},
|
|
891
918
|
logOutput: {
|
|
892
|
-
describe: 'Output the response body from the serverless function execution (It is suggested not to use this in production environments as it can reveal any secure data returned by the function in logs)',
|
|
919
|
+
describe: uiDeprecatedTag('Output the response body from the serverless function execution (It is suggested not to use this in production environments as it can reveal any secure data returned by the function in logs)'),
|
|
893
920
|
},
|
|
894
921
|
port: {
|
|
895
|
-
describe: 'Port to run the test server on',
|
|
922
|
+
describe: uiDeprecatedTag('Port to run the test server on'),
|
|
896
923
|
},
|
|
897
924
|
watch: {
|
|
898
|
-
describe: 'Watch the specified .functions folder for changes and restart the server',
|
|
925
|
+
describe: uiDeprecatedTag('Watch the specified .functions folder for changes and restart the server'),
|
|
899
926
|
},
|
|
900
927
|
},
|
|
901
928
|
positionals: {
|
|
902
929
|
path: {
|
|
903
|
-
describe: 'Path to local .functions folder',
|
|
930
|
+
describe: uiDeprecatedTag('Path to local .functions folder'),
|
|
904
931
|
},
|
|
905
932
|
},
|
|
906
933
|
},
|
|
@@ -1296,8 +1323,8 @@ export const commands = {
|
|
|
1296
1323
|
},
|
|
1297
1324
|
},
|
|
1298
1325
|
init: {
|
|
1299
|
-
describe:
|
|
1300
|
-
verboseDescribe: (configName, command, authMethod) => `Configure authentication for a HubSpot account. This will create a ${configName} file to store your account information. To configure authentication for additional accounts, run ${command}.\n\nThe recommended authentication method is ${chalk.bold(authMethod)}, which uses an access token tied to a specific user account
|
|
1326
|
+
describe: uiDeprecatedTag(`Create a CLI config file and configure authentication for your HubSpot account. Replaced by ${uiCommandReference('hs account auth')}.`),
|
|
1327
|
+
verboseDescribe: (configName, command, authMethod) => uiDeprecatedTag(`Configure authentication for a HubSpot account. This will create a ${configName} file to store your account information. To configure authentication for additional accounts, run ${command}.\n\nThe recommended authentication method is ${chalk.bold(authMethod)}, which uses an access token tied to a specific user account.\n\nThis command is deprecated because we are moving to global config, and the legacy config format will be replaced. Use ${uiCommandReference('hs account auth')} to create the global config file and add accounts to it, and ${uiCommandReference('hs account link')} to link accounts to a project directory. Run ${uiCommandReference('hs config migrate')} to migrate your existing config.`),
|
|
1301
1328
|
options: {
|
|
1302
1329
|
authType: {
|
|
1303
1330
|
describe: 'Authentication mechanism',
|
|
@@ -1315,6 +1342,7 @@ export const commands = {
|
|
|
1315
1342
|
configFileUpdated: (authType, account) => `Connected account "${account}" using "${authType}" and set it as the default account`,
|
|
1316
1343
|
},
|
|
1317
1344
|
logs: {
|
|
1345
|
+
deprecated: getLegacyConfigDeprecationMessage('hs init'),
|
|
1318
1346
|
updateConfig: `To update an existing config file, use the ${uiAuthCommandReference()} command.`,
|
|
1319
1347
|
},
|
|
1320
1348
|
errors: {
|
|
@@ -1336,7 +1364,6 @@ export const commands = {
|
|
|
1336
1364
|
claudeCode: 'Claude Code',
|
|
1337
1365
|
cursor: 'Cursor',
|
|
1338
1366
|
devin: 'Devin',
|
|
1339
|
-
gemini: 'Gemini CLI',
|
|
1340
1367
|
opencode: 'OpenCode',
|
|
1341
1368
|
vsCode: 'VSCode',
|
|
1342
1369
|
other: 'Other (manual setup)',
|
|
@@ -1344,6 +1371,7 @@ export const commands = {
|
|
|
1344
1371
|
client: 'Target apps to configure',
|
|
1345
1372
|
standalone: 'Use npx for all of the hs commands run by the MCP server. This allows you to use the MCP server without having the CLI globally installed.',
|
|
1346
1373
|
cliVersion: 'Pin a specific CLI version for standalone mode',
|
|
1374
|
+
skills: 'HubSpot skills to install for the selected tools. Pass --skills with no names to skip skills.',
|
|
1347
1375
|
docsSearch: 'Should the docs search mcp server be installed',
|
|
1348
1376
|
},
|
|
1349
1377
|
examples: {
|
|
@@ -1372,11 +1400,6 @@ export const commands = {
|
|
|
1372
1400
|
cursorNotFound: 'Cursor is not installed. Install it and re-run hs mcp setup.',
|
|
1373
1401
|
failedToConfigureCursor: 'Failed to configure Cursor',
|
|
1374
1402
|
configuredCursor: 'Configured Cursor',
|
|
1375
|
-
// Gemini
|
|
1376
|
-
configuringGemini: 'Configuring Gemini CLI...',
|
|
1377
|
-
configuredGemini: 'Configured Gemini CLI',
|
|
1378
|
-
geminiNotFound: "Gemini CLI is not installed (missing 'gemini' command). Install it and re-run hs mcp setup.",
|
|
1379
|
-
geminiInstallFailed: 'Failed to configure Gemini CLI',
|
|
1380
1403
|
alreadyInstalled: 'HubSpot CLI mcp server already installed, reinstalling',
|
|
1381
1404
|
// Devin
|
|
1382
1405
|
configuringDevin: 'Configuring Devin...',
|
|
@@ -1394,18 +1417,28 @@ export const commands = {
|
|
|
1394
1417
|
configuredVsCode: 'Configured VSCode',
|
|
1395
1418
|
vsCodeNotFound: "VSCode CLI is not installed (missing 'code' command). Install it and re-run hs mcp setup.",
|
|
1396
1419
|
vsCodeVersionUnsupported: 'VSCode 1.99 or later is required for MCP server support. Please update VSCode and try again.',
|
|
1420
|
+
// Skills
|
|
1421
|
+
installingSkills: 'Installing HubSpot skills...',
|
|
1422
|
+
installedSkills: (skillNames, targetDirs) => `Installed ${skillNames.join(', ')} in ${targetDirs.join(', ')}`,
|
|
1423
|
+
failedToInstallSkills: 'Failed to install HubSpot skills',
|
|
1397
1424
|
},
|
|
1398
1425
|
otherInstructions: {
|
|
1399
1426
|
header: 'To connect the HubSpot MCP server to another tool, add the following MCP server configuration.',
|
|
1400
1427
|
docsNote: "Each tool handles MCP setup differently. Check your tool's documentation for how to add an MCP server using a command or JSON config.",
|
|
1401
1428
|
commandLabel: 'Command:',
|
|
1402
1429
|
jsonLabel: 'JSON configuration (for tools that use a config file):',
|
|
1430
|
+
skillsNote: (skillsDir) => `To add HubSpot skills, copy the folders in ${skillsDir} to your tool's skills folder.`,
|
|
1403
1431
|
},
|
|
1404
1432
|
prompts: {
|
|
1405
1433
|
targets: '[--client] Which tools would you like to add the HubSpot CLI MCP server to?',
|
|
1406
1434
|
targetsRequired: 'Must choose at least one app to configure.',
|
|
1407
1435
|
standaloneMode: 'Do you want to run in standalone mode? (This will use npx @hubspot/cli instead of the installed hs command)',
|
|
1408
1436
|
cliVersion: 'Specify a CLI version to pin (leave blank for latest):',
|
|
1437
|
+
selectSkills: '[--skills] Which HubSpot skills do you want to install? (optional)',
|
|
1438
|
+
},
|
|
1439
|
+
skillDescriptions: {
|
|
1440
|
+
newApp: 'Plan and create a HubSpot app project',
|
|
1441
|
+
fixBuild: 'Find and fix a failed project build',
|
|
1409
1442
|
},
|
|
1410
1443
|
},
|
|
1411
1444
|
start: {
|
|
@@ -1617,8 +1650,8 @@ export const commands = {
|
|
|
1617
1650
|
},
|
|
1618
1651
|
},
|
|
1619
1652
|
migrateApp: {
|
|
1620
|
-
describe: uiDeprecatedTag(`Migrate a public app to the projects framework. ${MIGRATION_SUPPORT_CUTOFF_NOTICE}
|
|
1621
|
-
verboseDescribe: uiDeprecatedTag(`Migrate a public app to the projects framework. This command walks you through the fields required to complete the migration and downloads the project source code into a directory of your choosing.\n\n${chalk.bold.yellow(MIGRATION_SUPPORT_CUTOFF_NOTICE)}
|
|
1653
|
+
describe: uiDeprecatedTag(`Migrate a public app to the projects framework. ${MIGRATION_SUPPORT_CUTOFF_NOTICE}`),
|
|
1654
|
+
verboseDescribe: uiDeprecatedTag(`Migrate a public app to the projects framework. This command walks you through the fields required to complete the migration and downloads the project source code into a directory of your choosing.\n\n${chalk.bold.yellow(MIGRATION_SUPPORT_CUTOFF_NOTICE)}`),
|
|
1622
1655
|
examples: {
|
|
1623
1656
|
default: 'Migrate a public app to the projects framework',
|
|
1624
1657
|
},
|
|
@@ -1662,8 +1695,8 @@ export const commands = {
|
|
|
1662
1695
|
},
|
|
1663
1696
|
migrate: {
|
|
1664
1697
|
preamble: (platformVersion) => `This command will migrate an existing project to platformVersion ${platformVersion}. It will walk you through the fields required to complete the migration and download the new project source code into the project source directory. It will also copy all of your existing files to a new directory (archive) in case you need access to your old files later.`,
|
|
1665
|
-
describe: uiDeprecatedTag(`Migrate an existing project to the new version of the projects framework. ${MIGRATION_SUPPORT_CUTOFF_NOTICE}
|
|
1666
|
-
verboseDescribe: uiDeprecatedTag(`Migrate an existing project to a newer platform version. This command walks you through the fields required to complete the migration and downloads the new project source code into the project source directory. Your existing files are copied to a new directory (archive) in case you need access to them later.\n\n${chalk.bold.yellow(MIGRATION_SUPPORT_CUTOFF_NOTICE)}
|
|
1698
|
+
describe: uiDeprecatedTag(`Migrate an existing project to the new version of the projects framework. ${MIGRATION_SUPPORT_CUTOFF_NOTICE}`),
|
|
1699
|
+
verboseDescribe: uiDeprecatedTag(`Migrate an existing project to a newer platform version. This command walks you through the fields required to complete the migration and downloads the new project source code into the project source directory. Your existing files are copied to a new directory (archive) in case you need access to them later.\n\n${chalk.bold.yellow(MIGRATION_SUPPORT_CUTOFF_NOTICE)}`),
|
|
1667
1700
|
errors: {
|
|
1668
1701
|
noProjectConfig: (command) => `No project detected. Please run this command again from a project directory. If you are trying to migrate an app, run ${command}`,
|
|
1669
1702
|
},
|
|
@@ -1946,7 +1979,7 @@ export const commands = {
|
|
|
1946
1979
|
runCommand: (command) => `Run \`${uiCommandReference(command)}\``,
|
|
1947
1980
|
autoDeployDisabled: (deployCommand) => `Automatic deploys are disabled for this project. Run ${uiCommandReference(deployCommand)} to deploy this build.`,
|
|
1948
1981
|
autoDeploySkipped: (deployCommand) => `Auto-deploy was skipped for this build. Run ${uiCommandReference(deployCommand)} to deploy this build.`,
|
|
1949
|
-
releaseManagementRequired: (releaseCommand) => `This build is not live yet. Run ${uiCommandReference(releaseCommand)} to
|
|
1982
|
+
releaseManagementRequired: (releaseCommand) => `This build is not live yet. Run ${uiCommandReference(releaseCommand)} to release it. Apps then go live when you roll the release out in the projects UI.`,
|
|
1950
1983
|
uploadingWithProfile: (profileName, accountId) => `Initializing project upload with ${chalk.bold(profileName)} profile: ${uiAccountDescription(accountId)}`,
|
|
1951
1984
|
uploadingToAccount: (accountId) => `Initializing project upload to account ${uiAccountDescription(accountId)}`,
|
|
1952
1985
|
uploadedToAccount: (accountId) => `Project uploaded to ${uiAccountDescription(accountId)}`,
|
|
@@ -1961,7 +1994,7 @@ export const commands = {
|
|
|
1961
1994
|
describe: 'Skip confirmation prompts and force the upload.',
|
|
1962
1995
|
},
|
|
1963
1996
|
forceCreate: {
|
|
1964
|
-
describe: uiDeprecatedTag(`Automatically create project if it does not exist. Use ${uiCommandReference('--force')} instead
|
|
1997
|
+
describe: uiDeprecatedTag(`Automatically create project if it does not exist. Use ${uiCommandReference('--force')} instead.`),
|
|
1965
1998
|
},
|
|
1966
1999
|
message: {
|
|
1967
2000
|
describe: 'Add a message when you upload your project and create a build',
|
|
@@ -2024,26 +2057,54 @@ export const commands = {
|
|
|
2024
2057
|
describe: 'Download your project files from HubSpot.',
|
|
2025
2058
|
examples: {
|
|
2026
2059
|
default: 'Download the project myProject into myProjectFolder folder',
|
|
2060
|
+
currentProject: 'Download build 3 of the current project into the current project directory',
|
|
2027
2061
|
json: 'Output the download result as JSON for scripting',
|
|
2028
2062
|
},
|
|
2029
2063
|
logs: {
|
|
2030
2064
|
downloadCancelled: 'Cancelling project download',
|
|
2031
2065
|
downloadSucceeded: (buildId, projectName) => `Downloaded build "${buildId}" from project "${projectName}"`,
|
|
2066
|
+
filesOnlyInArchive: (files, hiddenCount, diffFilePath) => [
|
|
2067
|
+
'These files existed locally but are not in the downloaded build. They are available in the archive directory:',
|
|
2068
|
+
...files.map(file => `${indent(2)}- ${file}`),
|
|
2069
|
+
...(hiddenCount > 0
|
|
2070
|
+
? [`${indent(2)}...and ${hiddenCount} more`]
|
|
2071
|
+
: []),
|
|
2072
|
+
...(hiddenCount > 0 && diffFilePath
|
|
2073
|
+
? [`\nThe full list can be viewed in ${chalk.bold(diffFilePath)}`]
|
|
2074
|
+
: []),
|
|
2075
|
+
].join('\n'),
|
|
2076
|
+
filesCopiedBack: (copiedCount, srcPath) => `Copied ${copiedCount} ${copiedCount === 1 ? 'file' : 'files'} back to ${chalk.bold(srcPath)}`,
|
|
2077
|
+
sourceContentsArchived: (archiveLocation) => `The previous contents of your project have been moved to ${archiveLocation}. Once you have reviewed them, you can safely delete that directory.`,
|
|
2032
2078
|
},
|
|
2033
2079
|
errors: {
|
|
2034
2080
|
downloadFailed: 'Something went wrong downloading the project',
|
|
2035
2081
|
projectNotFound: (projectName, accountId) => `Your project ${chalk.bold(projectName)} could not be found in ${accountId}`,
|
|
2036
2082
|
noBuildIdToDownload: 'No build ID available for download',
|
|
2083
|
+
restoreFailed: (archiveDest) => `Extracting the downloaded build failed, and your original project files could not be restored automatically. They are in ${chalk.bold(archiveDest)}.`,
|
|
2084
|
+
archiveAlreadyExists: (archiveDest) => `Cannot download into the current project because ${chalk.bold(archiveDest)} already exists. Delete or rename it and run the command again.`,
|
|
2037
2085
|
},
|
|
2038
2086
|
warnings: {
|
|
2039
|
-
|
|
2087
|
+
filesNotCopiedBack: (failedCount) => `${failedCount} ${failedCount === 1 ? 'file' : 'files'} could not be copied back. ${failedCount === 1 ? 'It is' : 'They are'} still available in the archive directory.`,
|
|
2088
|
+
sourceWillBeArchived: (archiveLocation) => `Your current project source files will be moved to ${archiveLocation}.\nBack up any local changes in this project before you continue.`,
|
|
2089
|
+
sourceRestored: 'Extracting the downloaded build failed. Your original project files have been restored. The archive directory was left in place and can be deleted.',
|
|
2090
|
+
},
|
|
2091
|
+
archiveLocation: (archivePath) => `the archive directory in your project root (${chalk.bold(archivePath)})`,
|
|
2092
|
+
prompts: {
|
|
2093
|
+
confirmCopyFilesBack: (fileCount) => `[--keep-local-files] Copy ${fileCount === 1 ? 'this file' : `these ${fileCount} files`} back into your project source directory?`,
|
|
2094
|
+
confirmDownload: (buildId, projectName) => `[--force] Download build "${buildId}" of project "${projectName}"?`,
|
|
2040
2095
|
},
|
|
2041
2096
|
options: {
|
|
2042
2097
|
build: {
|
|
2043
|
-
describe: 'The build to download',
|
|
2098
|
+
describe: 'The build to download (defaults to the latest build)',
|
|
2099
|
+
},
|
|
2100
|
+
force: {
|
|
2101
|
+
describe: 'Skip the confirmation prompt before archiving your source',
|
|
2102
|
+
},
|
|
2103
|
+
keepLocalFiles: {
|
|
2104
|
+
describe: 'Copy local files missing from the build back into the source directory without prompting (--no-keep-local-files skips)',
|
|
2044
2105
|
},
|
|
2045
2106
|
project: {
|
|
2046
|
-
describe: 'The name of the project to download',
|
|
2107
|
+
describe: 'The name of the project to download (defaults to the current project)',
|
|
2047
2108
|
},
|
|
2048
2109
|
dest: {
|
|
2049
2110
|
describe: 'Destination folder for the project',
|
|
@@ -2064,9 +2125,33 @@ export const commands = {
|
|
|
2064
2125
|
},
|
|
2065
2126
|
feedback: {
|
|
2066
2127
|
describe: 'Leave feedback or file a bug report.',
|
|
2128
|
+
verboseDescribe: `Leave feedback or file a bug report.\n\nPass ${uiCommandReference('--message')} to send feedback from the terminal. Run ${uiCommandReference('hs feedback')} without it to open the feedback form in your browser instead.\n\nThe feedback includes your account ID, your user ID, and the CLI version.`,
|
|
2129
|
+
options: {
|
|
2130
|
+
message: {
|
|
2131
|
+
describe: 'Feedback to send. If omitted, opens the feedback form in your browser.',
|
|
2132
|
+
},
|
|
2133
|
+
source: {
|
|
2134
|
+
describe: `Who is sending the feedback. Required with ${uiCommandReference('--message')} unless the ${FEEDBACK_SOURCE_ENV_VAR} environment variable is set.`,
|
|
2135
|
+
},
|
|
2136
|
+
},
|
|
2137
|
+
examples: {
|
|
2138
|
+
openForm: 'Open the feedback form in your browser',
|
|
2139
|
+
submit: 'Send feedback from the terminal',
|
|
2140
|
+
submitAsAgent: 'Send feedback on behalf of an AI agent',
|
|
2141
|
+
},
|
|
2067
2142
|
openPrompt: 'Open the feedback form in your browser?',
|
|
2068
2143
|
success: (url) => `We opened ${uiLink('the developer feedback form', url)} in your browser.`,
|
|
2069
2144
|
error: (url) => `Navigate to ${uiLink('the developer feedback form', url)} to leave feedback.`,
|
|
2145
|
+
nonInteractive: (url) => `To send feedback from the terminal, run ${uiCommandReference('hs feedback --message "<message>" --source <user|agent>')}. To use the browser instead, navigate to ${uiLink('the developer feedback form', url)}.`,
|
|
2146
|
+
submitSuccess: 'Your feedback has been successfully submitted. Thank you.',
|
|
2147
|
+
errors: {
|
|
2148
|
+
blankMessage: `Feedback cannot be blank. Pass your feedback with ${uiCommandReference('hs feedback --message "<message>" --source <user|agent>')}.`,
|
|
2149
|
+
messageTooLong: (length) => `Feedback must be ${MAX_FEEDBACK_LENGTH} characters or fewer. Your message has ${length} characters.`,
|
|
2150
|
+
containsCredentials: 'Feedback cannot contain an access key, token, or secret from your HubSpot config. Remove it, then try again.',
|
|
2151
|
+
sourceRequired: `${uiCommandReference('--message')} requires ${uiCommandReference('--source')}. Pass ${uiCommandReference('--source user')} if you are a person, or ${uiCommandReference('--source agent')} if you are an AI agent.`,
|
|
2152
|
+
noAccount: `To send feedback from the terminal, authenticate an account with ${uiCommandReference('hs account auth')}. To use the feedback form instead, run ${uiCommandReference('hs feedback')} without ${uiCommandReference('--message')}.`,
|
|
2153
|
+
submitFailed: `Could not send your feedback. To use the feedback form instead, run ${uiCommandReference('hs feedback')} without ${uiCommandReference('--message')}.`,
|
|
2154
|
+
},
|
|
2070
2155
|
},
|
|
2071
2156
|
installDeps: {
|
|
2072
2157
|
help: {
|
|
@@ -3411,6 +3496,121 @@ export const lib = {
|
|
|
3411
3496
|
noSchemaForCommand: 'No schema defined for this command',
|
|
3412
3497
|
validationFailed: 'JSON output may be missing or malformed fields. The output schema may be out of date.',
|
|
3413
3498
|
},
|
|
3499
|
+
agentHelp: {
|
|
3500
|
+
headings: {
|
|
3501
|
+
conventions: chalk.bold('Conventions:'),
|
|
3502
|
+
jsonOutput: chalk.bold('JSON output:'),
|
|
3503
|
+
workflows: chalk.bold('Workflows:'),
|
|
3504
|
+
exitCodes: chalk.bold('Exit codes:'),
|
|
3505
|
+
commands: chalk.bold('All commands:'),
|
|
3506
|
+
},
|
|
3507
|
+
conventions: [
|
|
3508
|
+
'More help: To see the workflows that use one command, run `hs <command> --agent-help`.',
|
|
3509
|
+
'JSON output: Commands that support `--json` print one JSON object to stdout when they finish. Errors and warnings print to stderr.',
|
|
3510
|
+
'JSON schemas: To print the JSON Schema for the output of a command, run the command with `--json-schema`.',
|
|
3511
|
+
'Prompts: Commands prompt for values that you do not pass as flags. To run a command without prompts, pass each value as a flag.',
|
|
3512
|
+
'Long-running commands: `hs project dev`, `hs project watch`, `hs cms watch`, and `hs cms theme preview` run until they are stopped and can prompt for input. Do not run them from your shell, even in the background. Ask the user to run them in a separate terminal window.',
|
|
3513
|
+
'Accounts: Commands use the default account in the CLI config. To use a different account, pass `--account <name or ID>`. To see the configured accounts, run `hs account list`.',
|
|
3514
|
+
'Environment variables: To read the account from `HUBSPOT_ACCOUNT_ID` and `HUBSPOT_PERSONAL_ACCESS_KEY` instead of the config file, pass `--use-env`.',
|
|
3515
|
+
'Config file: The global config file is `~/.hscli/config.yml`. To use a different file, pass `--config <path>`.',
|
|
3516
|
+
'Color: To remove color from the output, pass `--no-color` or set `NO_COLOR`.',
|
|
3517
|
+
'Debug logs: To print debug logs, pass `--debug`.',
|
|
3518
|
+
'MCP server: To connect the HubSpot Dev MCP server to an AI coding tool, run `hs mcp setup`.',
|
|
3519
|
+
'Feedback: To send feedback about the CLI, run `hs feedback --message "<message>" --source agent`. Send one short line about a bug, a missing command or flag, or anything that confused the user. Keep it about the CLI. Do not include secrets, access keys, file contents, or personal data. Then continue with the task.',
|
|
3520
|
+
],
|
|
3521
|
+
jsonOutput: {
|
|
3522
|
+
schema: 'With `--json`, the command prints one JSON object to stdout. The object matches this JSON Schema:',
|
|
3523
|
+
noSchema: 'With `--json`, the command prints JSON to stdout. The CLI does not define a schema for this output.',
|
|
3524
|
+
},
|
|
3525
|
+
workflows: [
|
|
3526
|
+
{
|
|
3527
|
+
title: 'Authenticate an account',
|
|
3528
|
+
steps: [
|
|
3529
|
+
{
|
|
3530
|
+
command: 'hs account auth',
|
|
3531
|
+
description: 'Ask the user to run this command in their own terminal. It can open a browser page where the user creates a personal access key, and then it prompts for the key. Do not ask the user to paste the key into the conversation.',
|
|
3532
|
+
},
|
|
3533
|
+
{
|
|
3534
|
+
command: 'hs account list',
|
|
3535
|
+
description: 'List the accounts in the CLI config.',
|
|
3536
|
+
},
|
|
3537
|
+
{
|
|
3538
|
+
command: 'hs account use <account>',
|
|
3539
|
+
description: 'Set the default account. Commands use the default account unless you pass `--account`.',
|
|
3540
|
+
},
|
|
3541
|
+
],
|
|
3542
|
+
},
|
|
3543
|
+
{
|
|
3544
|
+
title: 'Create a project',
|
|
3545
|
+
steps: [
|
|
3546
|
+
{
|
|
3547
|
+
command: 'hs project create --name <name> --dest <directory> --project-base app --distribution <private|marketplace> --auth <oauth|static> --features --json',
|
|
3548
|
+
description: 'Create a project with an app in a new directory. Pass every flag to skip the prompts. A `--features` flag with no values adds no features.',
|
|
3549
|
+
},
|
|
3550
|
+
{
|
|
3551
|
+
command: 'hs project validate --json',
|
|
3552
|
+
description: 'Run this command in the project directory. It checks the project files before you upload them.',
|
|
3553
|
+
},
|
|
3554
|
+
],
|
|
3555
|
+
},
|
|
3556
|
+
{
|
|
3557
|
+
title: 'Generate test data',
|
|
3558
|
+
steps: [
|
|
3559
|
+
{
|
|
3560
|
+
command: 'hs test-account create --name <name> --description <description> --marketing-level ENTERPRISE --ops-level ENTERPRISE --service-level ENTERPRISE --sales-level ENTERPRISE --content-level ENTERPRISE --commerce-level ENTERPRISE',
|
|
3561
|
+
description: 'Create a developer test account and save it to the CLI config. Pass every flag to skip the prompts. Do not pass `--json`. With `--json`, the command does not save the account to the config, and the output includes the personal access key of the account.',
|
|
3562
|
+
},
|
|
3563
|
+
{
|
|
3564
|
+
command: 'hs test-account import-data --account <test account> --file-path <import.json> --skip-confirm',
|
|
3565
|
+
description: 'Import CRM records into the test account. The JSON file uses the request format of the CRM imports API: https://developers.hubspot.com/docs/guides/api/crm/imports. Each `fileName` in the file is a path relative to the current directory.',
|
|
3566
|
+
},
|
|
3567
|
+
],
|
|
3568
|
+
},
|
|
3569
|
+
{
|
|
3570
|
+
title: 'Develop a project',
|
|
3571
|
+
steps: [
|
|
3572
|
+
{
|
|
3573
|
+
command: 'hs project create',
|
|
3574
|
+
description: 'Create the project. The "Create a project" workflow shows the flags that skip the prompts.',
|
|
3575
|
+
},
|
|
3576
|
+
{
|
|
3577
|
+
command: 'hs project upload --json',
|
|
3578
|
+
description: 'Run this command in the project directory. It uploads the project and creates a build. If auto-deploy is on, it also deploys the build, and the output includes `deployId`.',
|
|
3579
|
+
},
|
|
3580
|
+
{
|
|
3581
|
+
command: 'hs project deploy --build <buildId> --json',
|
|
3582
|
+
description: 'Deploy the build. Use this command if the upload output has no `deployId`.',
|
|
3583
|
+
},
|
|
3584
|
+
{
|
|
3585
|
+
command: 'hs project dev',
|
|
3586
|
+
description: 'Ask the user to run this command in a separate terminal window. It starts local development and runs until it is stopped. Changes upload from the Local Dev Panel, or as you edit with `--auto-upload`. To test on a test account, also pass `--testing-account <test account ID>` and `--project-account <developer account ID>`.',
|
|
3587
|
+
},
|
|
3588
|
+
{
|
|
3589
|
+
command: 'hs project list-builds --limit 1 --json',
|
|
3590
|
+
description: 'Show the status of the latest build. `deployedBuildId` is the build that is deployed now.',
|
|
3591
|
+
},
|
|
3592
|
+
],
|
|
3593
|
+
},
|
|
3594
|
+
{
|
|
3595
|
+
title: 'Investigate a failed build',
|
|
3596
|
+
steps: [
|
|
3597
|
+
{
|
|
3598
|
+
command: 'hs project list-builds --limit 1 --json',
|
|
3599
|
+
description: 'Get the latest build. Each entry in `subbuildStatuses` has the status and error message of one component.',
|
|
3600
|
+
},
|
|
3601
|
+
{
|
|
3602
|
+
command: 'hs project validate --json',
|
|
3603
|
+
description: 'Validate the local project files.',
|
|
3604
|
+
},
|
|
3605
|
+
{
|
|
3606
|
+
command: 'hs project upload --json',
|
|
3607
|
+
description: 'Upload the project again after you fix the errors.',
|
|
3608
|
+
},
|
|
3609
|
+
],
|
|
3610
|
+
},
|
|
3611
|
+
],
|
|
3612
|
+
exitCodes: AGENT_HELP_EXIT_CODES,
|
|
3613
|
+
},
|
|
3414
3614
|
DevServerManager: {
|
|
3415
3615
|
portConflict: (port) => `The port ${port} is already in use.`,
|
|
3416
3616
|
notInitialized: 'The Dev Server Manager must be initialized before it is started.',
|
|
@@ -3585,6 +3785,13 @@ export const lib = {
|
|
|
3585
3785
|
declineDefaultAccountExplanation: `To develop on a different account, run ${uiCommandReference('hs account use')} to change your default account, then re-run ${uiCommandReference('hs project dev')}.`,
|
|
3586
3786
|
},
|
|
3587
3787
|
},
|
|
3788
|
+
serverlessSunset: {
|
|
3789
|
+
deprecationNotice: (command) => `The ${uiCommandReference(command)} command is deprecated. ${SERVERLESS_SUNSET_NOTICE} ${uiLink(SERVERLESS_CHANGELOG_LINK_TEXT, SERVERLESS_SUNSET_CHANGELOG_URL)}`,
|
|
3790
|
+
creationBlocked: (command) => `The ${uiCommandReference(command)} command is disabled. ${SERVERLESS_CREATION_BLOCKED_NOTICE} Existing functions can no longer be edited from November 17, 2026 and stop running on February 1, 2027. ${uiLink(SERVERLESS_CHANGELOG_LINK_TEXT, SERVERLESS_SUNSET_CHANGELOG_URL)}`,
|
|
3791
|
+
editingDisabled: (command) => `The ${uiCommandReference(command)} command is disabled. Serverless functions can no longer be created or edited in the Design Manager. Existing functions stop running on February 1, 2027. Build your serverless functions in Developer Projects instead. ${uiLink(SERVERLESS_CHANGELOG_LINK_TEXT, SERVERLESS_SUNSET_CHANGELOG_URL)}`,
|
|
3792
|
+
uploadEditingBlockedHint: `If this upload was rejected, it is because serverless functions can no longer be created or edited in the Design Manager. Build your serverless functions in Developer Projects instead. ${uiLink(SERVERLESS_CHANGELOG_LINK_TEXT, SERVERLESS_SUNSET_CHANGELOG_URL)}`,
|
|
3793
|
+
uploadBlockedHint: `If this upload was rejected, it is because serverless functions can no longer be created in the Design Manager, so new function folders can't be uploaded. Build new serverless functions in Developer Projects instead. ${uiLink(SERVERLESS_CHANGELOG_LINK_TEXT, SERVERLESS_SUNSET_CHANGELOG_URL)}`,
|
|
3794
|
+
},
|
|
3588
3795
|
middleware: {
|
|
3589
3796
|
updateNotification: {
|
|
3590
3797
|
notifyTitle: chalk.bold('Update available'),
|
|
@@ -3652,6 +3859,12 @@ export const lib = {
|
|
|
3652
3859
|
generateSafeFilenameDifferentiator: {
|
|
3653
3860
|
failedToCheckFiles: 'Failed to check files for filename differentiator. Falling back to timestamp.',
|
|
3654
3861
|
},
|
|
3862
|
+
archive: {
|
|
3863
|
+
errors: {
|
|
3864
|
+
archiveNotFound: (archiveDest) => `Archive directory not found: ${archiveDest}`,
|
|
3865
|
+
srcDirInsideArchive: (srcDir) => `The source directory "${srcDir}" cannot be the archive directory or inside it`,
|
|
3866
|
+
},
|
|
3867
|
+
},
|
|
3655
3868
|
validateProjectConfig: {
|
|
3656
3869
|
configNotFound: `Unable to locate a project configuration file. Try running again from a project directory, or run ${uiCommandReference('hs project create')} to create a new project.`,
|
|
3657
3870
|
},
|
|
@@ -3675,6 +3888,7 @@ export const lib = {
|
|
|
3675
3888
|
warning: (files) => `The following *-hsmeta.json files will be skipped.\nThis CLI version doesn't support the features they require:\n${files.map(f => ` ${chalk.bold(f)}`).join('\n')}\nRun ${uiCommandReference('hs upgrade')} to update the CLI, which may add support for these features.`,
|
|
3676
3889
|
uploadWarning: (files) => `The following *-hsmeta.json files will be skipped during upload.\nThis CLI version doesn't support the features they require:\n${files.map(f => ` ${chalk.bold(f)}`).join('\n')}\nRun ${uiCommandReference('hs upgrade')} to update the CLI, which may add support for these features.`,
|
|
3677
3890
|
prompt: '[--force] Continue anyway?',
|
|
3891
|
+
jsonRequiresForce: (files) => `The following *-hsmeta.json files would be skipped during upload:\n${files.map(f => ` ${chalk.bold(f)}`).join('\n')}\nRe-run with ${uiCommandReference('--force')} to upload anyway.`,
|
|
3678
3892
|
},
|
|
3679
3893
|
components: {
|
|
3680
3894
|
unableToGetUidFromHsmeta: 'Unable to get UID from hsmeta',
|
|
@@ -3716,6 +3930,7 @@ export const lib = {
|
|
|
3716
3930
|
},
|
|
3717
3931
|
handleProjectUpload: {
|
|
3718
3932
|
emptySource: (srcDir) => `Source directory "${srcDir}" is empty. Add files to your project and rerun ${uiCommandReference('hs project upload')} to upload them to HubSpot.`,
|
|
3933
|
+
noFilesToUpload: (srcDir) => `No files in source directory "${srcDir}" were included in the upload because every file was ignored. Rerun ${uiCommandReference('hs project upload --debug')} to see which files were ignored and why.`,
|
|
3719
3934
|
compressed: (byteCount) => `Project files compressed: ${byteCount} bytes`,
|
|
3720
3935
|
compressing: (path) => `Compressing build files to "${path}"`,
|
|
3721
3936
|
fileFiltered: (filename) => `Ignore rule triggered for "${filename}"`,
|
|
@@ -3905,6 +4120,7 @@ export const lib = {
|
|
|
3905
4120
|
useEnv: 'Use environment variable config',
|
|
3906
4121
|
jsonOutput: 'Format output as JSON',
|
|
3907
4122
|
jsonSchema: 'Print the JSON output schema and exit',
|
|
4123
|
+
agentHelp: 'Show help with workflows and conventions for AI agents',
|
|
3908
4124
|
debug: 'Set log level to debug',
|
|
3909
4125
|
color: 'Enable colored output (use --no-color to disable)',
|
|
3910
4126
|
},
|
|
@@ -3965,6 +4181,7 @@ export const lib = {
|
|
|
3965
4181
|
message: (dataFileNames, cliAccount) => `You are importing [${dataFileNames.join(', ')}] into ${uiAccountDescription(cliAccount?.accountId)}. Continue?`,
|
|
3966
4182
|
},
|
|
3967
4183
|
importDataTestAccountSelectPrompt: {
|
|
4184
|
+
message: '[--account] Select a developer test account:',
|
|
3968
4185
|
errors: {
|
|
3969
4186
|
noAccountsFound: 'No accounts found.',
|
|
3970
4187
|
noChildTestAccountsFound: (parentAccountId) => `No developer test accounts found under the parent account ${uiAccountDescription(parentAccountId)}`,
|
|
@@ -4129,9 +4346,9 @@ export const lib = {
|
|
|
4129
4346
|
},
|
|
4130
4347
|
},
|
|
4131
4348
|
downloadProjectPrompt: {
|
|
4132
|
-
selectProject: 'Select a project to download:',
|
|
4349
|
+
selectProject: '[--project] Select a project to download:',
|
|
4133
4350
|
errors: {
|
|
4134
|
-
projectNotFound: (projectName, accountId) => `Your project ${projectName} could not be found in ${accountId}. Please select a valid project:`,
|
|
4351
|
+
projectNotFound: (projectName, accountId) => `[--project] Your project ${projectName} could not be found in ${uiAccountDescription(accountId)}. Please select a valid project:`,
|
|
4135
4352
|
accountIdRequired: 'An account ID is required to download a project.',
|
|
4136
4353
|
},
|
|
4137
4354
|
},
|
|
@@ -4492,6 +4709,7 @@ export const lib = {
|
|
|
4492
4709
|
oauth2AccessTokenNotFound: (accountId) => `The OAuth2 access token could not be found for accountId ${uiAccountDescription(accountId)}`,
|
|
4493
4710
|
personalAccessKeyMissing: (accountId) => `The account "${uiAccountDescription(accountId)}" is configured to use a access key for authentication and is missing a "personalAccessKey" in the configuration file`,
|
|
4494
4711
|
personalAccessKeyTokenRetrievalFailed: (accountId) => `An OAuth2 access token for account "${uiAccountDescription(accountId)} could not be retrieved using the "personalAccessKey" provided`,
|
|
4712
|
+
accessTokenMissing: (accountId) => `The account "${uiAccountDescription(accountId)}" is configured to use an access token for authentication and is missing an access token`,
|
|
4495
4713
|
authConfigurationMissing: (accountId) => `The accountId ${uiAccountDescription(accountId)} is missing authentication configuration`,
|
|
4496
4714
|
availableCMSModes: (modes) => `Available CMS publish modes are: ${modes}`,
|
|
4497
4715
|
invalidCmsPublishMode: (cmsPublishMode, modesMessage) => `The CMS publish mode "${cmsPublishMode}" is invalid. ${modesMessage}`,
|
|
@@ -4506,7 +4724,7 @@ export const lib = {
|
|
|
4506
4724
|
legacyCrmCardMigrationDocs: () => `For more information on migrating legacy-crm-card components, follow ${uiLink('these docs', 'https://developers.hubspot.com/docs/apps/developer-platform/build-apps/migrate-an-app/migrate-legacy-crm-cards-to-app-cards')}`,
|
|
4507
4725
|
sourceContentsMoved: (newLocation) => `The contents of your old source directory have been moved to ${newLocation}, move any required files to the new source directory.`,
|
|
4508
4726
|
projectMigrationWarningTitle: (platformVersion) => `Important: Migrating to platformVersion ${platformVersion} is irreversible`,
|
|
4509
|
-
projectMigrationWarning: (platformVersion) => uiBetaTag(`Running the ${uiCommandReference('hs project migrate')} command will permanently upgrade your project to platformVersion ${platformVersion}. This action cannot be undone. To ensure you have access to your original files, they will be copied to a new directory (archive) for safekeeping.\n\nThis command will guide you through the process, prompting you to enter the required fields and will download the new project source code into your project source directory
|
|
4727
|
+
projectMigrationWarning: (platformVersion) => uiBetaTag(`Running the ${uiCommandReference('hs project migrate')} command will permanently upgrade your project to platformVersion ${platformVersion}. This action cannot be undone. To ensure you have access to your original files, they will be copied to a new directory (archive) for safekeeping.\n\nThis command will guide you through the process, prompting you to enter the required fields and will download the new project source code into your project source directory.`),
|
|
4510
4728
|
exitWithoutMigrating: 'Exiting without migrating',
|
|
4511
4729
|
success: {
|
|
4512
4730
|
downloadedProject: (projectName, projectDest) => `Saved ${projectName} to ${projectDest}`,
|