diff --git a/README.md b/README.md index 4ec01b6..eaecd42 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # vercel-open -The `vercel-open` custom command extension for the Vercel CLI +https://github.com/user-attachments/assets/c27b4e68-87d6-44b4-b113-0bbaf186879c + +The `vc open` custom command extension for the Vercel CLI. + +It makes easy to jump to vercel deployment URL from your terminal. ## Installation @@ -10,28 +14,34 @@ npm install -g vercel-open ## Usage -**Automatic** - Requires that your working directory is a linked Vercel project: +Assuming your terminal is in a Vercel project folder: + +**Resume information** + +It show resume information about your project ``` -vc open # open the vercel dahboard for the current project -vc open logs # open logs of the project -vc open logs --timeline=maximum # any query parameter is supported +vc open info + +▲ overview https://vercel.com/vercel-labs/vercel-open/ +▲ current (production) https://vercel.com/vercel-labs/vercel-open/9PEUQN2Z5BpAFxEsRtXoSkj8nhK9/ +▲ latest (preview) https://vercel.com/vercel-labs/vercel-open/GSM3jnwUA8qEAUY42ZaXBVRV2QrJ/ ``` -**Custom** - Providing a `$team/$project` slug that will be opened: +**Opening in the browser** + +It opens the URL in your browser ``` -vc open vercel/v0 logs # will open `https://vercel.com/vercel/v0/logs` in the browser +vc open [current|latest] [--visit] ``` -Also `vc open info` will print relevant information about your project: +**Jumping to a section** -``` -> vc open info +It navigates to a project tab section. -▲ overview https://vercel.com/vercel-labs/vercel-open/ -▲ current (production) https://vercel.com/vercel-labs/vercel-open/AtQTsruE87Lu6Nz3fhCrFyxV9t3T/ -▲ latest (preview) https://vercel.com/vercel-labs/vercel-open/3AaqTjcDGqfEW6FjbywYKNaQfDW9/ +``` +vc open [current|latest] [--query-parameter] ``` ## License diff --git a/bin/welcome.mjs b/bin/welcome.mjs deleted file mode 100644 index f04d486..0000000 --- a/bin/welcome.mjs +++ /dev/null @@ -1,10 +0,0 @@ -import pc from 'picocolors' - -console.log( - [ - pc.black(`✨ ${pc.white('vercel-open')} installed ✨`), - pc.black(`For using it, just type '${pc.white('vc open')}' or '${pc.white('vercel open')}' in your terminal`), - '', - pc.black(`Type '${pc.white('vc open help')}' to learn about the command`) - ].join('\n') -) diff --git a/demo.mp4 b/demo.mp4 new file mode 100644 index 0000000..d2cf187 Binary files /dev/null and b/demo.mp4 differ diff --git a/package.json b/package.json index 8b9db84..2fc34cc 100644 --- a/package.json +++ b/package.json @@ -61,7 +61,6 @@ "scripts": { "build": "tsup --format esm bin/index.ts -d bin/", "contributors": "(npx git-authors-cli && npx finepack && git add package.json && git commit -m 'build: contributors' --no-verify) || true", - "install": "node bin/welcome.mjs", "postrelease": "npm run release:tags && npm run release:github && (ci-publish || npm publish --access=public)", "prepublishOnly": "npm run build", "release": "standard-version -a",