CodeScout documentation

CodeScout is an AI coding agent that runs on your own computer. You describe what you want in plain language, in Arabic or English, and the agent plans the work, reads your project, writes and edits code, runs commands, searches the web and checks its own results, step by step, in front of you.

It has two parts:

• The desktop app (Windows), where you work with the agent inside your project folders.
• The website, where you manage your account, top up credits, buy plans, redeem codes and follow your usage.

You never need your own AI API keys. CodeScout routes every request to a suitable model for the quality level you choose, and charges prepaid credits for what you actually use.

1. 01Create a free account on the website with your email, Google or GitHub.
2. 02Download CodeScout for Windows and run the installer.
3. 03Open the app and choose Sign in. The website opens in your browser; confirm there and you are signed in to the app automatically.
4. 04Top up credits from the Credits page (from $5), or redeem a code you received.
5. 05In the app, open a project folder, pick a quality level, and describe your task in the message box.

A good first task: "Explain the structure of this project and suggest three improvements." The agent will read the files and answer without changing anything.

System requirements

Install on Windows

1. 01Go to the Download page and click Download for Windows. The installer (CodeScout-Setup-<version>.exe) is saved to your Downloads folder.
2. 02Double-click the installer and follow the setup wizard. Installing only for you needs no administrator password; you can also change the install folder.
3. 03If Windows shows "Windows protected your PC", click More info, then Run anyway (see below).
4. 04When setup finishes, CodeScout opens. A shortcut is added to the Start menu and the desktop.

About the Windows SmartScreen warning

SmartScreen warns about apps that do not yet have a long download history or a paid code-signing certificate. This is expected for a new app and does not mean the file is harmful. Only download CodeScout from the official Download page, which serves files from updates.codescout.online.

Uninstall

Open Settings → Apps → Installed apps, find CodeScout and choose Uninstall. Your conversations and settings in %USERPROFILE%\.dsh are kept, so a reinstall picks up where you left off; delete that folder to remove them too.

The app uses your CodeScout website account. Sign-in happens in your normal browser, so you can use any method you set up on the website (email and password, Google or GitHub).

1. 01In the app, click Sign in.
2. 02Your browser opens the CodeScout website. Sign in there if you are not already.
3. 03Approve the connection. The browser tab tells you it is done, and the app switches to your account within a few seconds.

Email verification codes

Every email and password sign-in on the website has two steps: your password, then a 6-digit code we email you. New accounts confirm their email with a code too, and "Forgot password" sends a code instead of a link. Codes expire after 10 minutes; use Resend code if one does not arrive (check your spam folder first).

You stay signed in when you close the app, restart your computer or install an update. The session renews itself automatically in the background.

To sign out, open the account menu at the bottom of the sidebar and choose Sign out. This removes the session stored on that computer.

Each conversation works inside a project folder on your computer. The agent can only read and change files in the folder you open (and within the permission mode you choose), so open the root folder of the project you want to work on.

• Start a new conversation for each separate task. Short, focused conversations give better results and use fewer credits.
• Your conversations are saved on your computer and listed in the sidebar, so you can return to them later.
• You can attach images (for example a screenshot of a bug or a design) to your message.
• While the agent works you see every step: the files it reads, the edits it makes and the commands it runs. You can stop it at any time.

Writing good requests

• Say what you want and why: "Add a dark mode toggle to the settings page; the colors are in theme.css."
• Mention file names, error messages and constraints you already know.
• For large work, ask for a plan first, review it, then ask the agent to carry it out.
• Ask the agent to run the tests or the build after a change, so it can check its own work.

Slash commands

Type / in the message box to see the available commands. Useful ones include:

You decide how much the agent may do on its own. Choose a permission mode from the selector under the message box:

When approval is needed, the app shows exactly what the agent wants to do, and you choose to allow or deny it.

Skills are expert playbooks the agent loads when a task needs them. Modes let you force a specialist skill for the whole conversation.

Specialist modes

Run the same command again (or /<mode> off) to turn the mode off. A chip above the message box shows the active mode.

CodeScout UI Skill

When you ask the agent to design or build a website, landing page, app screen or dashboard, it automatically loads the CodeScout UI Skill: a design system with curated styles, color palettes, font pairings and UX rules. When a design needs pictures, the agent can generate them with image generation.

Ask the agent for an image in any language, for example "Make a hero image of a cozy coffee shop at sunrise". The agent writes a detailed prompt in English, generates the image and shows a preview in the conversation. The file is also saved in your project, under generated-images/ by default.

• Each generated image costs 10 credits, charged only when the image is generated successfully.
• There is a daily limit on the number of images per account. It resets every day at 00:00 UTC.
• Prompts are always sent in English, which gives the image models the best results.

Connections let the agent work with your online services, for example GitHub (repositories, issues, pull requests), Vercel and Cloudflare (deployments and projects).

1. 01Click the connections button next to the message box (or open Settings → Connections).
2. 02Choose a service and click Connect. Your browser opens the service's own sign-in page; approve access there.
3. 03Back in the app, the service shows as connected. Ask the agent to use it, for example "Open a pull request with these changes".

The agent only uses a connected service when your request needs it. Connection tokens are stored on your computer. You can disconnect a service at any time from the same place.

Supabase and WordPress are linked per project instead: you paste the keys for that project once and they apply only to that project. See WordPress connection for the WordPress steps.

Link a project to a WordPress site so the agent can work on it directly: read and edit theme and plugin files, manage posts, pages and media, query the database, install or update plugins and themes, and take backups first. The link goes through the WP CodeScout Connector plugin and is set up per project.

Set it up

1. 01Install and activate the WP CodeScout Connector plugin on your WordPress site.
2. 02In the WordPress dashboard, open CodeScout Connector and generate a connection. Copy the Connection ID (it starts with cs_) and the API token (it starts with csc_). The token is shown only once.
3. 03Choose the permissions this connection may use (files, database, plugins, themes, content, backups and more). Destructive operations stay off unless you turn them on.
4. 04In CodeScout, click the connections button next to the message box (or open Settings → Connections) and choose WordPress.
5. 05Paste the site URL, the Connection ID and the API token, then click Test and save. Nothing is saved unless the test succeeds.

Once connected, the dialog shows the WordPress account the connection acts as, the WordPress and plugin versions, and the permissions it allows. Ask the agent things like "List the installed plugins and themes" or "Change the header color in my child theme".

Safety

• The API token is stored only on your computer and is never shown to the agent.
• The site must use https:// (plain http works only for local sites such as localhost).
• The agent can only use the permissions you enabled in the plugin, and it makes changes only when you ask. It takes a backup before changing files or data.
• You can remove the connection from the same dialog at any time, or revoke the token from the plugin page in WordPress.

Pick a quality level for each message from the model selector in the app. Higher levels use stronger models: they handle harder tasks better but use credits faster.

You never choose a provider or manage API keys: the platform routes each level to the right model and automatically fails over to another key or model if one is unavailable.

CodeScout uses prepaid credits. Each request is charged when it finishes, based on how much text the model read and wrote, multiplied by the multiplier of the quality level you chose. Longer conversations and bigger answers cost more.

• Your balance is shown live on the website dashboard and inside the app.
• Every request is listed with its level and cost on the Credits page, so you always know where credits went.
• If your balance runs out, the agent pauses and asks you to top up. Nothing is charged for blocked requests.
• Credits you buy do not expire.

Saving credits

• Use a lower level for simple tasks.
• Start a new conversation for a new task instead of continuing a very long one, or use /compact.
• Point the agent at the right files instead of asking it to search the whole project.

1. 01Open the Credits page and choose an amount (from $5).
2. 02Optionally enter a coupon code and click Apply to see the discount.
3. 03Click Continue to payment. The secure checkout page opens on CodeScout itself: pay with a card, Google Pay or Apple Pay. If your bank asks for verification, it appears on the same page.
4. 04As soon as the payment is confirmed, the credits are added to your balance.

You can pay with Visa or Mastercard, Google Pay or Apple Pay (on supported devices). Payments are processed by XPay; we never see or store your card number. Prices are shown in USD and charged in EGP at the exchange rate locked when you open the payment. Your receipts and payment history are on the Billing page.

Plans

Every account starts on the free plan. Paid plans bundle credits with a duration; see the current offers on the Plans page. You get a notification before a plan expires.

Redeem codes

A redeem code adds credits or activates a plan for free. Enter it in the Redeem a code box on the Credits page. Each code can be used once per account, and codes may expire or have a limited number of uses.

Coupons

A coupon gives a discount (a percentage or a fixed amount) on a top-up or a plan purchase. Enter it at checkout before you pay. You still receive the full credits of the original amount.

• Dashboard: your balance, plan and recent activity at a glance.
• Statistics: daily usage charts by level and over time.
• In the app, Settings → Usage shows usage per day and per conversation.
• Notifications: low balance (below 2 credits), plan expiry and announcements. Important ones also appear inside the app.

Emails we send

CodeScout checks for updates automatically. When a new version is ready, the app downloads it in the background and offers to restart. Your conversations, settings and sign-in are kept across updates.

You can always download the latest installer from the Download page and install it over your current version.

• Conversations, code and files stay on your computer.
• Only the parts of a conversation needed to answer are sent, through the CodeScout gateway, to the AI model, and the gateway does not store their content.
• We keep usage metadata (level, size, time) for billing.

Read the full Privacy Policy.

Still stuck? Send /feedback from the app, or email [email protected] with what you did, what you expected and any error message.

Do I need my own OpenAI, Anthropic or DeepSeek API key?

No. CodeScout provides the models. You only pay credits for what you use.

Does the agent work offline?

No. The app runs on your computer, but the AI models run in the cloud, so an internet connection is required.

Can I use CodeScout on more than one computer?

Yes. Install it and sign in with the same account. Your balance is shared; conversations stay on the computer where they were created.

Which programming languages are supported?

All common languages and frameworks: JavaScript and TypeScript, Python, Java, C#, Go, PHP, Rust, SQL, HTML/CSS and more.

Can I get a refund for unused credits?

No. All purchases are final; see the Refund Policy. Start with a small top-up to try the service first.

Is there a macOS or Linux version?

Not yet. They are planned; the Download page will show them as soon as they are ready.

Email [email protected] for help with your account, payments or the app. Include the email of your CodeScout account and, for problems, what you did and any error message.

• In the app, send /feedback to report a bug or suggest an improvement; it reaches the team directly.
• Discord and Telegram communities are coming soon. The Contact page will link to them when they open.