Coding Expert

Documentation Index

Fetch the complete documentation index at: https://docs.xpertai.cn/llms.txt

Use this file to discover all available pages before exploring further.

• 📋 Automatically Review Issues: Intelligently analyze and categorize issues, providing solution suggestions
• 🔧 Automatically Modify Code: Automatically modify code files based on issues or requirements
• 🚀 Automatically Submit PRs: Create Pull Requests with auto-generated descriptions
• 🤝 Code Review: Intelligently review PRs and provide improvement suggestions
• 📝 Generate Documentation: Automatically generate or update project documentation

​

📦 Supported Platforms

​

🔧 Backend Configuration

​

Callback URL Rules

​

Environment Variables Configuration

# GitHub App Configuration
GITHUB_APP_SLUG=
GITHUB_APP_ID=
GITHUB_APP_PRIVATE_KEY=

# GitLab OAuth Configuration
GITLAB_CLIENT_ID=
GITLAB_CLIENT_SECRET=
GITLAB_REDIRECT_URI=http://localhost:3001/v1/git/connections/callback/gitlab
GITLAB_SCOPES=api read_user

# Gitee OAuth Configuration
GITEE_CLIENT_ID=
GITEE_CLIENT_SECRET=
GITEE_REDIRECT_URI=http://localhost:3001/v1/git/connections/callback/gitee
GITEE_SCOPES=user_info projects pull_requests

# Credentials Encryption Key (Required, 32 bytes)
GIT_CREDENTIALS_KEY=

• GIT_CREDENTIALS_KEY is required and must be a 32-byte string
• Ensure the API service actually reads this .env file (depending on the actual startup method, the file may be in the root directory or apps/api/.env) :::

​

🚀 Platform Configuration Steps

​

GitHub Configuration (App Mode)

​

1. Create GitHub App

1. Log in to GitHub, go to Settings → Developer settings → GitHub Apps
2. Click New GitHub App button
3. Fill in the application information:

   Field	Description	Example
   GitHub App name	Application name	XpertAI Coding Expert
   Homepage URL	Homepage URL	https://app.xpertai.cn
   Description	Application description	AI coding agent for automated code tasks
   Identification	URL slug	xpertai-coding-agent

4. Configure Webhook (optional):
   • Active: Uncheck (if Webhook is not needed)
   • Webhook URL: Leave empty
5. Configure App permissions:

   Permission	Access Level	Description
   Repository permissions
   - Administration	Read & write	Repository management
   - Contents	Read & write	Code content read/write
   - Issues	Read & write	Issue management
   - Pull requests	Read & write	PR management
   - Metadata	Read-only	Metadata read
   Organization permissions
   - Members	Read-only	Member read

6. Configure Where can this GitHub App be installed?
   • Select: Only on this account or Any account
7. Click Create GitHub App to create the app

​

2. Get and Save Credentials

​

3. User Authorization Flow

1. System redirects to GitHub App installation page
2. User selects repositories to authorize (all repositories or specific repositories)
3. Click Save to complete authorization
4. After successful authorization, the system can access the user’s authorized repositories

​

GitLab Configuration

​

OAuth Mode (Recommended)

1. Create GitLab Application

1. Log in to GitLab, go to User Settings → Applications
2. Fill in the application information:

   Field	Description	Example
   Name	Application name	XpertAI Coding Expert
   Redirect URI	Callback URL	http://localhost:3001/v1/git/connections/callback/gitlab

3. Check the following permissions (Scopes):

   Permission	Description
   api	Full API access
   read_user	Read user information

4. Click Save application to create the app

2. Get and Save Credentials

3. User Authorization Flow

1. System redirects to GitLab authorization page
2. User clicks Authorize to complete authorization
3. After successful authorization, the system can access the user’s GitLab repositories

​

PAT Mode

User Configuration Steps

1. User generates a Personal Access Token in GitLab
2. Select GitLab on the system connection page
3. Select PAT mode
4. Enter the following information:
   • Token: Personal access token
   • Base URL (optional): GitLab instance URL (if using self-hosted GitLab)

​

Gitee Configuration

​

OAuth Mode

1. Create Gitee Third-Party Application

1. Log in to Gitee, go to Settings → Third-Party Applications → Create Application
2. Fill in the application information:

   Field	Description	Example
   Application Name	Application name	XpertAI Coding Expert
   Application Introduction	Application description	AI coding agent for automated code tasks
   Application Homepage	Homepage URL	https://app.xpertai.cn
   Application Callback URL	Callback URL	http://localhost:3001/v1/git/connections/callback/gitee

3. Check the following permissions (Scopes):

   Permission	Description
   user_info	User information
   projects	Project access
   pull_requests	PR management

4. Click Create Application

2. Get and Save Credentials

3. User Authorization Flow

1. System redirects to Gitee authorization page
2. User clicks Agree to Authorize to complete authorization
3. After successful authorization, the system can access the user’s Gitee repositories

​

PAT Mode

User Configuration Steps

1. User generates a Personal Access Token in Gitee
2. Select Gitee on the system connection page
3. Select PAT mode
4. Enter the personal access token

​

Yunxiao Codeup Configuration (PAT Mode)

​

1. Create Yunxiao PAT

1. Log in to Yunxiao
2. Go to Personal Settings → Access Tokens → Create Access Token
3. Configure token permissions:

   Permission	Description
   Code Repository	Read and write code repositories
   Branch	Read and create branches
   Merge Request	Read and create merge requests
   Issue	Read and manage issues

4. Click Create and copy the generated token

​

2. User Configuration Steps

1. Select Yunxiao Codeup
2. Fill in the following information:
   • Organization ID: Yunxiao organization ID
   • Token: Personal access token

​

🚀 Using the Coding Expert

​

Available Tools

• Manually review all code changes
• Check if the agent’s modifications comply with project standards
• Verify that the functionality works correctly

​

4. Error Handling

• Configure error notification mechanisms to detect issues in time
• Log operations for troubleshooting
• Set up retry mechanisms for handling temporary errors

​

🔒 Security Considerations

​

1. Credential Security

• Do not commit sensitive information like Client Secret, AppSecret, Private Key to code repositories
• Regularly rotate application secrets and tokens
• Use environment variables to store sensitive information
• Ensure GIT_CREDENTIALS_KEY is stored securely

​

2. Access Control

• Limit the scope of repositories the Coding Expert can access
• Configure different application instances for different projects
• Regularly review the list of authorized applications

​

3. Audit Logs

• Enable platform audit logging
• Regularly check the Coding Expert’s operation records
• Handle abnormal operations promptly

​

📚 FAQ

​

Q1: What to do if authorization fails?

• Whether the callback URL is correctly configured (including protocol http/https)
• Whether application permissions are correctly checked
• Whether environment variables in .env file are correctly configured
• Whether the API service actually reads the .env file

​

Q2: Authorization succeeds but API returns 401/403 errors?

• Check if GITLAB_SCOPES or GITEE_SCOPES are exactly the same as the permissions configured in the platform application
• Confirm that the application permission scope is sufficient
• Recreate the application and ensure permission configuration is correct

​

Q3: Coding Expert cannot access private repositories?

• User has correctly authorized or provided a valid PAT
• PAT has permission to access the repository
• Whether the repository’s access settings allow third-party application access

​

Q4: How to limit the Coding Expert’s operation scope?

• Select specific repositories when installing GitHub App
• Clearly define the operation scope in the agent’s prompt
• Use branch protection rules to restrict operable branches

​

Q5: What to do if the code modified by the Coding Expert is incorrect?

• Enable branch protection and require manual review
• Configure CI/CD checks to automatically detect code issues
• Close problematic PRs promptly and provide feedback to the agent

​

🎓 Summary

1. ✅ Configure backend environment variables (.env)
2. ✅ Create applications on each platform (GitHub App / GitLab Application / Gitee Application)
3. ✅ Configure correct callback URLs and permission scopes
4. ✅ User completes authorization or provides PAT
5. ✅ Follow security best practices

​

🔗 Related Links

• GitHub Apps Documentation
• GitLab Applications Documentation
• Gitee Open Platform Documentation
• Yunxiao Open Platform Documentation