Skip to content
CoreClaw Logo CoreClaw

Project Structure

Project Root Required Files

Section titled “Project Root Required Files”

Python Project

Section titled “Python Project”
├── main.py                 # Main entry file
├── requirements.txt        # Python dependencies
├── README.md               # Project documentation
├── input_schema.json       # UI Worker input configuration file
├── output_schema.json      # UI Worker output configuration file
├── sdk.py                  # SDK file
├── sdk_pb2.py
├── sdk_pb2_grpc.py

Node.js Project

Section titled “Node.js Project”
├── main.js                 # Main entry file
├── package.json            # Node.js dependencies
├── README.md               # Project documentation
├── input_schema.json       # UI Worker input configuration file
├── output_schema.json      # UI Worker output configuration file
├── sdk.js                  # SDK file
├── sdk_pb.js
├── sdk_grpc_pb.js

Go Project

Section titled “Go Project”
├── main.go                 # Source entry file
├── go.mod                  # Go module file
├── go.sum                  # Go dependencies checksum
├── README.md               # Project documentation
├── input_schema.json       # UI Worker input configuration file
├── output_schema.json      # UI Worker output configuration file
├── GoSdk/                  # SDK directory
│   ├── sdk.go
│   ├── sdk.pb.go
│   └── sdk_grpc.pb.go

Core Files Explained

Section titled “Core Files Explained”

Core Entry File

Section titled “Core Entry File”
  • main.py / main.js: The runtime entry point for Python and Node.js Workers.
  • main.go: The source entry point for Go Workers. Go ZIP uploads must include the compiled Linux amd64 executable main at the ZIP root.
  • The filename must be main, with the extension depending on the chosen language.

Dependency Management

Section titled “Dependency Management”
LanguageFilePurpose
Node.jspackage.jsonNode.js dependencies
Pythonrequirements.txtPython dependencies
Gogo.modGo module definition

These files declare all dependencies required to run the project.

Configuration File: input_schema.json

Section titled “Configuration File: input_schema.json”
  • UI Worker input configuration file
  • Defines the input form displayed on the platform
  • See Input Schema for details

Configuration File: output_schema.json

Section titled “Configuration File: output_schema.json”
  • UI Worker output configuration file
  • Defines the output data table structure (column headers)
  • See Output Schema for details

Documentation: README.md

Section titled “Documentation: README.md”
  • Documentation of Worker functionality
  • Includes usage instructions and important notes

SDK Functionality Modules

Section titled “SDK Functionality Modules”

1. Environment Parameter Access

Section titled “1. Environment Parameter Access”
  • Get runtime parameters passed when the script starts
  • Access task configuration, authentication info, etc.

2. Data Storage

Section titled “2. Data Storage”
  • Define data table structure (headers)
  • Store collected result data
  • Support batch saving and resume from breakpoint

3. Log Output

Section titled “3. Log Output”
  • Standardized log interface
  • Support multiple log levels: INFO, WARN, ERROR
  • Logs are automatically collected and displayed by the platform