diff --git a/website/versioned_docs/version-1.6/agent-skill.md b/website/versioned_docs/version-1.6/agent-skill.md new file mode 100644 index 000000000..420a2d79d --- /dev/null +++ b/website/versioned_docs/version-1.6/agent-skill.md @@ -0,0 +1,40 @@ +--- +title: Agent skill +description: Learn about the available agent skill for the Apify CLI. +--- + +An agent skill is a Markdown file that contains guidance for coding agents. The Apify CLI ships its own skill that your agent loads automatically when a task involves the CLI. + +## View the skill + +To view the skill, run: + +```bash +apify help --skill +``` + +The output prints the contents of a `SKILL.md` file that matches your installed version of the Apify CLI. + +## Install the skill + +To have the skill installed persistently, redirect the output of `apify help --skill` into your agent's skills directory. The location depends on the agent type. + +Note that this approach creates a snapshot of the skill. Re-install the skill each time you upgrade the Apify CLI. + +### Claude Code + +For Claude Code, use: + +```bash +mkdir -p ~/.claude/skills/apify-cli +apify help --skill > ~/.claude/skills/apify-cli/SKILL.md +``` + +### Codex and other agents + +Codex and most other agents follow the [Agent Skills open standard](https://developers.openai.com/codex/skills). It loads skills from `.agents/skills` per repository or from `~/.agents/skills` per user: + +```bash +mkdir -p ~/.agents/skills/apify-cli +apify help --skill > ~/.agents/skills/apify-cli/SKILL.md +``` diff --git a/website/versioned_docs/version-1.6/installation.md b/website/versioned_docs/version-1.6/installation.md index 77a3c88b1..6710880f8 100644 --- a/website/versioned_docs/version-1.6/installation.md +++ b/website/versioned_docs/version-1.6/installation.md @@ -3,84 +3,81 @@ title: Installation description: Learn how to install Apify CLI using installation scripts, Homebrew, or NPM. --- -Learn how to install Apify CLI using installation scripts, Homebrew, or NPM. +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; ---- - -## Installation scripts -### MacOS / Linux - -```bash -curl -fsSL https://apify.com/install-cli.sh | bash -``` +Learn how to install Apify CLI. -### Windows +## Installation scripts -```powershell -irm https://apify.com/install-cli.ps1 | iex -``` +Installation scripts use [Bun](https://bun.sh/) to create a standalone executable file, so you don't need Node.js. -:::tip No need for Node.js +This approach eliminates Node.js dependency management, which is useful if you're a Python developer or work in non-Node.js environments. -If you install Apify CLI using our installation scripts, you don't need Node.js. The scripts use [Bun](https://bun.sh/) to create a standalone executable file. + + + ```bash + curl -fsSL https://apify.com/install-cli.sh | bash + ``` + + + ```powershell + irm https://apify.com/install-cli.ps1 | iex + ``` + + -This approach eliminates Node.js dependency management, which is useful for Python developers or users working in non-Node.js environments. +## Homebrew -::: +Homebrew automatically installs Node.js as a dependency. -## Homebrew +If you already have Node.js installed through another method, for example, `nvm`, it might create version conflicts. To fix it, modify your `PATH` environment variable to prioritize your preferred Node.js installation over Homebrew's version. ```bash brew install apify-cli ``` -:::tip Homebrew and Node.js dependency - -When you install Apify CLI using Homebrew, it automatically installs Node.js as a dependency. If you already have Node.js installed through another method (e.g., `nvm`), this may create version conflicts. - -If you experience Node.js version conflicts, modify your `PATH` environment variable to prioritize your preferred Node.js installation over Homebrew's version. - -::: - ## NPM -First, make sure you have [Node.js](https://nodejs.org) version 22 or higher with NPM installed on your computer: +1. Make sure you have [Node.js](https://nodejs.org) version 22 or higher with NPM installed: -```bash showLineNumbers -node --version -npm --version -``` + ```bash + node --version + npm --version + ``` -Install or upgrade Apify CLI by running: +1. Install or upgrade Apify CLI: -```bash -npm install -g apify-cli -``` + ```bash + npm install -g apify-cli + ``` + +
:::tip Troubleshooting -If you receive a permission error, read npm's [official guide](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally) on installing packages globally. +If you receive a permission error, read npm's [guide on installing packages globally](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally). ::: ## Verify installation -You can verify the installation process by running the following command: +To verify the installation process, run: ```bash apify --version ``` -The output should resemble the following (exact details like version or platform may vary): +The output includes installation details, for example: ```bash apify-cli/1.0.1 (0dfcfd8) running on darwin-arm64 with bun-1.2.19 (emulating node 24.3.0), installed via bundle ``` -## Upgrading +## Upgrade version -Upgrading Apify CLI is as simple as running the following command: +To upgrade Apify CLI to the latest version, run: ```bash apify upgrade diff --git a/website/versioned_sidebars/version-1.6-sidebars.json b/website/versioned_sidebars/version-1.6-sidebars.json index 35b2079a4..b7b29a3b4 100644 --- a/website/versioned_sidebars/version-1.6-sidebars.json +++ b/website/versioned_sidebars/version-1.6-sidebars.json @@ -1,20 +1,28 @@ [ [ { - "type": "doc", - "id": "index", - "label": "Overview" - }, - { - "type": "doc", - "id": "installation", - "label": "Installation" - }, - { - "type": "doc", - "id": "quick-start", - "label": "Quick start" - }, + "type": "category", + "collapsed": false, + "label": "Overview", + "link": {"type": "doc", "id": "index"}, + "items": [ + { + "type": "doc", + "id": "installation", + "label": "Installation" + }, + { + "type": "doc", + "id": "quick-start", + "label": "Quick start" + }, + { + "type": "doc", + "id": "agent-skill", + "label": "Agent skill" + } + ] + }, { "type": "doc", "id": "reference",